Difference between revisions of "Prim Class"

From TouchDesigner Documentation
Jump to: navigation, search
(Prim Class Auto Create)
(Prim Class Auto Create)
Line 1: Line 1:
 
{{TDClassSummary|summary=A Prim describes an instance to a single geometry primitive.  They are accessible through the SOP.prims member.}}
 
{{TDClassSummary|summary=A Prim describes an instance to a single geometry primitive.  They are accessible through the SOP.prims member.}}
<section begin=HELPBODY />
+
{{HelpbodyBegin}}
{{ClassMemberSection|empty=}}
+
{{ClassMemberSection|empty=
 +
|Sectionsummary=
 +
|items=
 +
 
{{ClassMember
 
{{ClassMember
 
     |class=Prim
 
     |class=Prim
Line 57: Line 60:
 
     |set=0
 
     |set=0
 
     |text=The primitive index in the list.
 
     |text=The primitive index in the list.
}}
+
}}}}
{{ClassMethodSection|empty=}}
+
{{ClassMethodSection|empty=
{{ClassMethod
+
|Sectionsummary=
    |class=Prim
+
|items=
    |name=eval
+
    |call=eval(u, v)
 
    |returns=
 
    |text=: -> Position
 
Evaluate the position on the primitive given the u,v coordinates. u,v should be in the range [0,1]. Polygons and curves ignore the v parameter.
 
center = op('box1').prim[0].eval(0.5, 0.5)
 
}}
 
 
{{ClassMethod
 
{{ClassMethod
 
     |class=Prim
 
     |class=Prim
Line 78: Line 75:
 
  destroyPoints - (Keyword, Optional) If True, its points are destroyed as well, if false, they are simply detached.  The argument is True by default.
 
  destroyPoints - (Keyword, Optional) If True, its points are destroyed as well, if false, they are simply detached.  The argument is True by default.
 
}}
 
}}
<section end=HELPBODY />
+
{{ClassMethod
<taggedhistory/>
+
    |class=Prim
 
+
    |name=eval
 +
    |call=eval(u, v)
 +
    |returns=
 +
    |text=: -> Position
 +
Evaluate the position on the primitive given the u,v coordinates. u,v should be in the range [0,1]. Polygons and curves ignore the v parameter.
 +
center = op('box1').prim[0].eval(0.5, 0.5)
 +
}}}}
 +
{{{{HelpbodyEnd}}}}
 +
{{{{History}}}}
 
{{{{#invoke:Category|list|Python Reference}}}}
 
{{{{#invoke:Category|list|Python Reference}}}}

Revision as of 14:51, 14 September 2017

A Prim describes an instance to a single geometry primitive. They are accessible through the SOP.prims member.


Members[edit]

center(Read Only):

Get or set the barycentric coordinate of this primitive. It is expressed as a named 4-tuple (x,y,z,w).

max(Read Only):

The maximum coordinates of this primitive along each dimension, expressed as a named 4-tuple (x,y,z,w).

min(Read Only):

The minimum coordinates of this primitive along each dimension, expressed as a named 4-tuple (x,y,z,w)

normal(Read Only):

The calculated normal vector of this primitive, expressed as a named 4-tuple (x,y,z,w).

owner(Read Only):

The OP to which this object belongs.

size(Read Only):

The size of this primitive along each dimension, expressed as a named 4-tuple (x,y,z,w).

weight(Read Only):

The associated weight of the primitive. Only certain primitives, such as those created by the Metaball SOP can modify this value from its default of 2.0.

index(Read Only):

The primitive index in the list.

Methods[edit]

destroy(destroyPoints=True):

:

Destroy and remove the actual primitive this object refers to. This operation is only valid when the primitive belongs to a scriptSOP. Note: after this call, other existing Prim objects in this SOP may no longer be valid.

destroyPoints - (Keyword, Optional) If True, its points are destroyed as well, if false, they are simply detached. The argument is True by default.

eval(u, v):

: -> Position

Evaluate the position on the primitive given the u,v coordinates. u,v should be in the range [0,1]. Polygons and curves ignore the v parameter.

center = op('box1').prim[0].eval(0.5, 0.5)

{{{{HelpbodyEnd}}}} {{{{History}}}} {list}

An Operator Family that reads, creates and modifies 3D polygons, curves, NURBS surfaces, spheres, meatballs and other 3D surface data.