Difference between revisions of "Prim Class"

From TouchDesigner Documentation
Jump to: navigation, search
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|label=Prim|summary=A Prim describes an instance to a single geometry primitive.  They are accessible through the SOP.prims member.}}
 
<section begin=HELPBODY />
 
<section begin=HELPBODY />
 
{{ClassMemberSection|empty=
 
{{ClassMemberSection|empty=

Revision as of 14:09, 25 May 2018

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


Members[edit]

centertdu.Position :

Get or set the barycentric coordinate of this primitive. It is expressed as a tdu.Position object.

maxtdu.Position (Read Only):

The maximum coordinates of this primitive along each dimension, expressed as a tdu.Position object.

mintdu.Position (Read Only):

The minimum coordinates of this primitive along each dimension, expressed as a tdu.Position object.

normaltdu.Vector (Read Only):

The calculated normal vector of this primitive, expressed as a tdu.Vector object.

directiontdu.Vector (Read Only):

A normalized vector pointing from the centroid of the SOP to the centroid of this primitive. Available builds 2018.40000 or later.

ownerOP (Read Only):

The OP to which this object belongs.

sizetdu.Position (Read Only):

The size of this primitive along each dimension, expressed as a tdu.Position object.

weightfloat (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.

indexint (Read Only):

The primitive index in the list.

Methods[edit]

eval(u, v)td.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)

destroy(destroyPoints=True)None:

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.

{{SubSection|title=Special Functions |text=

len(Prim)int:

Returns the total number of vertices.

a = len(op('box1').prim[0])

[index]td.Vertex:

Get specific vertex given an integer index

n = op('box1').prims[5][0]

[row, col]td.Vertex:

Get specific vertex from a Mesh given integer row and column values.

v = op('grid1').prims[2,3]

Iteratortd.Vertex:

Iterate over each vertex.

for m in op('box1').prims[5]:
	# do something with m, which is a Vertex

TouchDesigner Build:

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

Any of the procedural data operators. OPs do all the work in TouchDesigner. They "cook" and output data to other OPs, which ultimately result in new images, data and audio being generated. See Node.