On this page |
|
The Solid Object DOP creates a Solid Object inside the DOP simulation. It creates a new object and attaches the subdata required for it to be a properly conforming Solid Object. Solid Objects can be simulated using the Finite Element Solver.
Solid objects are different than rigid bodies. Solid objects are flexible, which makes it possible for them to deform, and can be used to simulate materials such as flesh, wood, and concrete. Solid objects are also able to break dynamically during a simulation, based on the deformation that happens during the simulation.
You can use a tetrahedral mesh in SOPs to create your solid object. Your solid geometry should satisfy guidelines that ensure a fast-running and good looking simulation.
See the section on solid simulation for more information.
Creating a solid object
-
Select the geometry to convert to a solid object.
-
On the Solid tab, click the Solid Object tool.
Note
Once you convert geometry to a solid object, you can only transform, rotate, and scale it at the first frame.
Parameters
Model
Shape Stiffness
This determines how strongly the Solid Object resists changes in shape. In the isotropic use case (Anisotropic Strength all 1), this physical constant is also known as shear modulus, modulus of rigidity, or Lame’s second parameter. If the units of length are set to meters, then the Shape Stiffness parameter has units of GPa.
Volume Stiffness
This determines how strongly the Solid Object resists changes in volume. In the isotropic use case (Anisotropic Strength all 1), this physical constant is also known as Lame’s first parameter. If the units of length are set to meters, then the Shape Stiffness parameter has units of GPa.
Damping Ratio
This value should lie between 0 and 1. It controls the rate of energy loss as a result of the rate of deformation. A value of 0 means that there is no loss of energy due to internal damping forces. A value of 1 means that the object is critically damped, in which case the object comes to rest in the quickest possible way without oscillating. The higher the damping ratio, the less the solid oscillates and the quicker the object’s motion will come to rest. The effect of damping is independent of your geometry’s resolution.
Mass Density
This is the mass per cubed length unit. The mass density can be made lower or higher in parts of the object using the primitive attribute volumemassdensity
, which works as a multiplier for the parameter. The higher the mass density, the less the object tends to accelerate as a result of any internal or external forces (F = m a, Newton’s second law).
Enable Fracturing
This enables or disables all fracturing for this object.
Note
Before any fracturing can occur, Enable Fracturing must also be enabled on the Finite Element Solver.
Fracture Threshold
The amount of relative stretch that will cause the geometry to break up into separate parts during the simulation. For example, if the threshold is set to 0.1, the geometry will break in places where there is more than 10% stretch compared to the rest geometry.
Realistic solid objects are not equally strong everywhere, there are weak parts that tend to fracture before any other parts. To create these relatively weaker parts you can create a vertex attribute called fracturethreshold
. This attribute is a multiplier for the Fracture Threshold parameter, so that you can still use the Fracture Threshold to control the overall strength of the object.
Friction Coefficient
The coefficient of friction of the object. A value of 0 means the object is frictionless. This governs how much the velocity that is tangential to the contact plane is affected by collisions. When two objects are in contact, the solver multiplies the friction coefficients of the involved object to get the effective friction coefficient for that contact.
Anisotropic Strength
These values allow you to make the internal forces of the Solid Object behave in an anisotropic way; in that case, the amount of stress will differ depending on the direction in which the object is deformed. An example of an anisotropic material is wood, which has a different strength along the grain than perpendicular to the grain. The materialuvw
vertex or point attribute can be used to specify the internal directions of the Solid Object’s internal force model. For example, in the case of wood, the U direction could be aligned with the grain of the wood, while the VW coordinates are chosen perpendicular to the grain of the wood. In this case, the strength along the grain can be separately controlled using the U component of the Anisotropic Strength.
Geometry
Initial Geometry
This geometry determines the initial simulated state of the object. It determines the initial position and velocity for each of the points.
This is the geometry that is used for the computation of internal forces and for collision detection. Don’t use more tetrahedrons than you need to get a good looking motion; more tetrahedrons does not always translate to more quality. The fewer tetrahedrons you use, the better the simulation speed is. If extra detail needs to be added, it is recommended that you use the Embedded Geometry.
You can use the Tetrahedralize SOP to create a suitable input mesh. It is important that you enable the quality option on the Tetrahedralize SOP. Otherwise, the interior of your Solid Object won’t have enough degrees of freedom to be flexible.
Enable Embedding
Turns on/off the use of embedded geometry.
Embedded Geometry
This geometry is embedded into and deformed along with the simulated tetrahedral mesh.
Import Rest Geometry
This option allows you to specify and animate the rest positions that are used by the simulation inside the SOP network (without having to use a SOP solver). The option defines whether the rest positions should be imported from a SOP geometry node at each frame. When enabled, the solver will copy rest positions from the point attribute restP
of the SOP geometry node onto the attribute restP
on the simulation geometry at each frame. If no restP
exists, then the 'P' attribute from the SOP geometry node is copied instead.
Rest Geometry Path
The path to the SOP node that will serve as the source of the rest positions.
Import Target Geometry
This option allows you to specify and animate the target positions that are used by the simulation inside the SOP network (without having to use a SOP solver). The option defines whether the target positions should be imported from a SOP geometry node at each frame. When enabled, the solver will copy target positions from the point attribute targetP
of the SOP geometry node onto the attribute targetP
on the simulation geometry at each frame. If no targetP
exists, then the P
attribute from the SOP geometry node is copied instead.
Target Geometry Path
The path to the SOP node that will serve as the source of the target positions. The positions should be stored in an attribute with the name targetP
. If this attribute is not found, the P
attribute is used as a fallback.
Stiffness
This coefficient determines how strongly the finite element solver tries to make the point positions match the target point positions. The solver creates an imaginary potential force for this purpose.
Damping
This coefficient determines how strongly the finite element solver tries to make the point velocities match the target point velocities. The solver creates an imaginary dissipation force for this purpose.
Fracturing
Enable Fracturing
Allows the tetrahedrons of this object to break apart when impacted beyond the force set by the Fracture threshold below. The solver must also have fracturing on (which is the default for the solver).
Fracture Threshold
The relative amount of stress in any direction above which dynamic fracturing will occur. This lets you control how quickly the object will break into pieces as a result of stresses inside the object.
Realistic objects don’t have the same fracture threshold everywhere. To achieve this, you can use a point attribute with the name fracturethreshold
that acts as a local multiplier for the per-object fracture threshold.
It is recommended that you use the primitive attribute fracturepart
to assign integer numbers to clumps of tetrahedrons that should never be broken up into smaller pieces. Creating these clumps prevents individual tetrahedrons from breaking off. The Solid Fracture SOP can be a useful tool for creating this fracturepart
attribute. You can create a fracturepart
on the embedded geometry as well. This way, the fractured pieces in the simulated geometry and the embedded geometry can be properly matched.
Collisions
Collide with objects
If enabled, the geometry in this object will collide with all other objects. These other objects may belong to the same solver or they may be be Static Objects, RBD Objects, or the Ground Plane. When the Collision Detection parameter on the Static Object is set to Use Volume Collisions, then the polygon vertices will be tested for collision against the signed distance field (SDF) of the Static Object. When Collision Detection is set to Use Surface Collisions, then geometry-based continuous collision detection is used. The geometry-based collisions collide points against polygons, and edges against edges.
When surface-based collisions are used, only polygons and tetrahedrons in the Static Object are considered. Other types of primitives, for example spheres, are be ignored. The geometry of the external objects (e.g. Static Object) is treated as being one-sided; only the outsides of the polygons, determined by the winding order, oppose collisions.
When volume-based collisions are enabled, only points will be colliding against the volumes, not the interiors of polygons and tetrahedrons. When colliding against small volumes, this may mean that you need to increase the number of points on your mesh to get accurate collision results.
Collide with other objects with same solver
When enabled, this object will collide with other objects that have the same solver. These collisions are handled using continuous collision detection, based on the geometry (polygons and/or tetrahedrons). For collisions between objects on the same solver, the polygons are treated as two-sided. Both sides of the polygons collide. The surface of a tetrahedral mesh only collides on one side: the outside.
Collide within this object
If disabled, no two tetrahedrons within this object can collide with each other.
Collide within each component
If disabled, no two tetrahedrons that belong on the same connected component may collide with each other.
Collide within each fracture part
This option only has an effect when fracturing is enabled on the solver. If disabled, no two tetrahedrons that belong on the same fracture part may collide with each other. Fracture parts are controlled by the integer-valued fracturepart
primitive attribute.
Properties
External volume properties
Division Method
If Non Square is chosen, the specified size is divided into the given number of divisions of voxels. However, the sides of these voxels may not be equal, possibly leading to distorted simulations.
When an axis is specified, that axis is considered authoritative for determining the number of divisions. The chosen axis' size will be divided by the uniform divisions to yield the voxel size. The divisions for the other axes will then be adjusted to the closest integer multiple that fits in the required size.
Finally, the size along non-chosen axes will be changed to represent uniform voxel sizes. If the Max Axis option is chosen, the maximum sized axis is used.
When By Size is chosen, the Division Size will be used to compute the number of voxels that fit in the given sized box.
Uniform Divisions
The resolution of the key axis on the voxel grid. This allows you to control the overall resolution with one parameter and still preserve uniform voxels. The Uniform Voxels option specifies which axis should be used as the reference. It is usually safest to use the maximum axis.
Tolerance
This specifies the tolerance used for ray intersections when computing the SDF. This value is multiplied by the size of the geometry and is scale invariant.
Sign Sweep Threshold
After the fix signs process is complete there can still be inconsistent areas in the SDF. Large blocks can become stabilized and stick out of the SDF. A second sign sweep pass can be performed to try to eliminate these blocks.
The sign sweep threshold governs how big of a jump has to occur for a sign transition to be considered inconsistent. If the values of the sdf change by more than this threshold times the width of the cell, it is considered an invalid sign transition. The original geometry is then ray intersected to determine inside/outside and the result used to determine which sign is correct. The correct sign is then propagated forward through the model.
Max Sign Sweep Count
The sign sweeps are repeated until no signs are flipped (ie, all transitions are within the threshold) or this maximum is reached. Too low of a sign sweep threshold may prevent the process from converging. Otherwise, it tends to converge very quickly.
Drag
Normal Drag
The component of drag in the directions normal to the surface. Increasing this will make the object go along with any wind that blows against it. For realistic wind interaction, the Normal Drag should be chosen larger (about 10 times larger) than the tangent drag.
Tangent Drag
The component of drag in the direction tangent to the surface. Increasing this will make the object go along with any wind that blows tangent to the object.
External Velocity Field
The name of the external velocity fields on affectors that the object will
respond to. The default is vel
, which will make the object react to fluids
and smoke when the Tangent Drag and the Normal Drag have been
chosen sufficiently large. The Tangent Drag and Normal Drag forces
are computed by comparing the object’s velocity with the external velocity.
External Velocity Offset
This offset is added to any velocity that’s read from the velocity field. When there’s no velocity field, then the offset can be used to create a wind force which has constant velocity everywhere. This wind effect is more realistic and more accurate than the wind that is generated by DOP Forces.
Visualization
Creation
Creation Frame Specifies Simulation Frame
Determines if the creation frame refers to global Houdini
frames ($F
) or to simulation specific frames ($SF
). The
latter is affected by the offset time and scale time at the
DOP network level.
Creation Frame
The frame number on which the object will be created. The object is created only when the current frame number is equal to this parameter value. This means the DOP Network must evaluate a timestep at the specified frame, or the object will not be created.
For example, if this value is set to 3.5, the
Timestep parameter of the DOP Network must be changed to
1/(2*$FPS)
to ensure the DOP Network has a timestep at frame
3.5.
Number of Objects
Instead of making a single object, you can create a number of
identical objects. You can set each object’s parameters
individually by using the $OBJID
expression.
Object Name
The name for the created object. This is the name that shows up in the details view and is used to reference this particular object externally.
Note
While it is possible to have many objects with the same name, this complicates writing references, so it is recommended to use something like $OBJID
in the name.
Solve On Creation Frame
For the newly created objects, this parameter controls whether or not the solver for that object should solve for the object on the timestep in which it was created.
Usually this parameter will be turned on if this node is creating objects in the middle of a simulation rather than creating objects for the initial state of the simulation.
Allow Caching
By preventing a large object from being cached, you can ensure there is enough room in the cache for the previous frames of its collision geometry.
This option should only be set when you are working with a very large sim. It is much better just to use a larger memory cache if possible.
Initial State
Controls on this tab allow you to set the initial states of the object’s position, pivot, rotation, initial velocity, and angular velocity.
Attributes
The finite element solver will recognize and use attributes on the simulated geometry. In the DOP network, this simulation geometry is attached to the simulated object as a sim-data with name Geometry
. When an object is created, then the geometry and all the corresponding attributes are read from the Initial Geometry. This includes the standard position and velocity point attributes P
and v
.
The finite element solve supports input attributes and output attributes. Some attributes, such as the simulation state, are both input and output attributes. The input attributes include multiplier attributes for material properties, fracture attributes, and attributes for controlling target positions and corresponding hard/soft constraints. The output attributes include optional attributes for tet quality, energy densities, FEM node forces, collision info attributes and fracture info attributes.
Material Property Multiplier Attributes
Each of the material properties of a simulated object can be locally modified using multiplier point attributes. As a rule, each of the material properties in the Model tab of an object can be affected by a multiplier attribute. As a rule, the name of the parameter is the name of the attribute. The name of the attribute is the name that is displayed after "Parameter:" when you hover over a parameter with your mouse cursor.
You can locally change the material properties of the object using point attributes. For example, you can make some polygons resists stretching and bending more than other polygons. These attributes work as multipliers for the parameters in the Model tab: The stiffness multiplier is a convenient way to modify the local stiffness for all object types that are recognized by the finite element solver:
Name | Class | Type | Description |
---|---|---|---|
stiffness
|
Point | Float | Multiplier for all types of stiffnesses. |
dampingratio
|
Point | Float | Multiplier for all damping ratios. |
massdensity
|
Point | Float | Multiplier for all mass densities. |
For solid objects, the following multiplier point attributes can be used to modify the local behavior:
Name | Class | Type | Description |
---|---|---|---|
solidstiffness
|
Point | Float | Multiplier for both the shape stiffness and the volume stiffness of a Solid Object. |
solidshapestiffness
|
Point | Float | Multiplier for the shape stiffness of a Solid Object. |
solidvolumestiffness
|
Point | Float | Multiplier for the volume stiffness of a Solid Object. |
solidmassdensity
|
Point | Float | Multiplier for the mass density of a Solid Object. |
Fracturing Control Attributes
When you create a simulation with fracturing, it is recommended to specify chunks of tetrahedrons that you want to stay together. Otherwise, the fracturing process may create a very large amount of separate pieces, many of which may consist of single tetrahedrons. For this purpose, you can assign a nonnegative integer to each chunk using the fracturepart
attribute. In areas where you don’t want to specify parts, you can set fracturepart
to -1, which means that each primitive in that region will become its own part. Real-life materials tend not to be equally strong everywhere. For realistic results, it is recommended to vary the Fracture Threshold locally using the vertex attribute fracturethreshold
.
fracturepart
|
Primitive | Integer | Partitions the object into unbreakable parts. Must be either -1 (no part) or a nonnegative number that indicates a part. |
enablefracturing
|
Point/Vertex | Integer | Locally enable/disable fracturing for points or vertices. |
fracturethreshold
|
Point/Vertex | Float | Multiplier for the object’s Fracture Threshold. |
Drag Force Control Attributes
The behavior of the drag force can be modified locally using the following attributes:
normaldrag
|
Primitive | Float | Multiplier for the object’s Normal Drag. |
tangentdrag
|
Primitive | Float | Multiplier for the object’s Tangent Drag. |
Reference Attributes
The attribute restP
can be used to specify the rest position for all the object points. The attribute materialP
is similar to the rest position, but it must not be changed during a simulation. Among other things, materialP
defines the mass and the strength of the internal forces that act within the simulation geometry. The attribute materialP
can be thought of as an initial rest position.
table>>
The attribute baseP
can be used to specify a generic base position for all the object points. This attribute’s values must not be changed during a simulation. When the user does not specify baseP
, the solver creates this point attribute based on the point positions on the creation frame. This attribute is used as a fallback; whenever the user does not specify materialP
, the attribute baseP
is read instead. In the same way, baseP
is used as a fallback for when no restP
or targetP
attributes are provided. Finally, baseP
is used to bind the simulated and the embedded geometry, in the embedded workflow (e.g., a T-pose). This embedded binding looks at the baseP
position attribute on both the simulated geometry and the embedded geometry. If no baseP
attribute is provided by the user on the embedded geometry, the solver creates the baseP
attribute on the embedded geometry based on the position P
at the creation frame.
The attribute initialpid
stores the initial point index for each point. This is the point index at the creation time of the object. This attribute is created only when fracturing is enabled on both the object and the solver. The finite element solver uses this attribute for the options Import Rest Geometry and Import Target Geometry to transfer animated positions and velocities in SOPs to the current fractured topology in the simulated object.
Name | Class | Type | Description |
---|---|---|---|
initialpid
|
Point | Integer | Initial point index for each point. |
Target Attributes
Target attributes can be used to make a simulated object partially follow a target animation. The attribute targetP
can be used to specify a target position for each object point. When you use the Import Target Geometry option on the simulated object, the targetP
will be set automatically every frame. Alternatively, you can create and modify these attributes yourself, using a Multi Solver and a SOP Solver. The target positions and velocities allow the user to mix animation and simulation in a very stable way (assuming the Target Strength and Target Damping parameters have been set on the object). You can set the Target Strength and Target Damping parameters on the object to express how strongly the object should match the target position and velocity, respectively. This is a way to create soft constraints. You can use the pintoanimation
to create hard constraints that make the simulated points follow targetP
exactly.
Name | Class | Type | Description |
---|---|---|---|
targetP
|
Point or Vertex | Vector | Target position of each point. |
targetstrength
|
Point | Float | Multiplier for the object’s Target Strength. If this attribute is missing, a multiplier of 1 is used at all points. |
targetdamping
|
Point | Float | Multiplier for the object’s Target Damping. If this attribute is missing, a multiplier of 1 is used at all points. |
pintoanimation
|
Point | Int |
When 1, the point is hard constrained to the target animation (e.g., targetP ). When zero, the point is unconstrained.
|
State Attributes
Below is a list of attributes that are maintained internally by the solver. Each of these attributes is written to at the end of each solve and read from at the start of the next solve. You should not modify any of these attributes yourself. When you do, the solver is likely to become unstable and you will get bad results. However, you can inspect the values in these attributes in your network for visualization or for the creation of secondary effects.
At each frame, the finite element solver computes a new physical state for each simulated object. The physical state of the object is represented by the point attributes P
and v
, representing the position and velocity, respectively. The solver’s integration scheme maintains additional attributes a
for acceleration and j
for jerk.
The point attributes P
, v
, a
, and j
store the current integration state of the object. These attributes should not be modified during the simulation because the finite element solver will become unstable and produce low-quality results.
Name | Class | Type | Description |
---|---|---|---|
P
|
Point | Vector | Do not modify! Current position of each object point. |
v
|
Point | Vector | Do not modify! Current velocity of each object point. |
accel
|
Point | Vector | Do not modify! Current acceleration of each object point. |
jerk
|
Point | Vector | Do not modify! Current jerk of each object point. |
Embedded Geometry Attributes
These attributes are created on the Embedded Geometry of the Solid Object.
The parent
attribute is maintained by the embedding code itself, and
should not be modified.
The baseP
point attribute can be provided on the Embedded Geometry by the user to control the binding between the simulated geometry and the embedded geometry.
If no baseP
is provided, it will be copied from the point positions stored in P
at the creation frame.
The alignment happens relative to the baseP
point attribute on the simulated geometry. If the simulated geometry has a materialP
vertex or point attribute, then this attribute takes precedence, allowing control per vertex, rather than per point, if necessary.
When you want to ensure that embedded geometry ends up on the desired side of a fracture between simulated geometry, you can use the combination of vertex attributes baseP
on the embedded geometry and restP
on the simulated geometry.
This allows you to line up the embedded geometry with the separate parts in the simulated geometry, for example using the Exploded View SOP.
The fracturepart
attribute allows you to make sure that the embedded geometry follows the right parts when it gets fractured. When both the simulated and the embedded geometry have the fracturepart
attribute, the finite element solver will parent embedded geometry to simulated geometry that has the same fracture part.
Name | Class | Type | Description |
---|---|---|---|
parent
|
Primitive | Float | The index of a parent primitive in the simulated geometry. |
baseP
|
Point | Float | Base positions used for alignment with simulated mesh. |
fracturepart
|
Point or Vertex | Float | Optional user-specified fracture part ID. |
P
|
Point | Float | Positions that correspond to the deformed state. |
v
|
Point | Float | Velocities that correspond to the deformed state. |
N
|
Point or Vertex | Float | Normals that correspond to the deformed state. |
Optional Output Attributes
These are attributes that are optionally generated by the solver, when the generation is enabled on the simulated object. These attributes can be useful for visualization, for example, using the Finite Element Visualization SOP. Additionally, these attributes may be used to create secondary effects, for example, particles flying off in regions where fracturing occurs. The optional output attributes are also expected by the Finite Element Visualization SOP.
The following attribute is generated when Create Quality Attributes is turned on:
Name | Class | Type | Description |
---|---|---|---|
quality
|
Primitive | Float | A quality metric between 0 (worst) and 1 (best) |
Finite element simulation tends to be sensitive to the quality of the incoming primitives. Low quality primitives may slow down, destabilize or lock a finite element simulation. Low quality primitives are best avoided by using the Solid Embed as a tool to create your tet mesh. Although various quality metrics exist for tetrahedra, the one that’s generated by the solver in this attribute is the one that best matches Houdini’s finite element solution.
The solver generates energy-density attributes for each object that has Create Energy Attributes turned on. The material property settings in the Model tab and the corresponding multiplier attributes result in potential energy, energy dissipation and kinetic energy. For each of these three contributions, local densities are computed within the solver. These densities and quantities derived from them are used to determine the motion and behavior of the objects that are solved by the finite element solver.
Name | Class | Type | Description |
---|---|---|---|
potentialdensity
|
Point | Float | The local density of deformation energy |
dissipationdensity
|
Point | Float | The local density of the rate of energy loss |
kineticdensity
|
Point | Float | The local density of the kinetic energy |
The potentialdensity
attribute is directly affected by the stiffness parameters in the Model tab. The kineticdensity
is proportional to the mass density that is specified for the object. The dissipationdensity
is related to the damping settings.
If Create Fracture Attributes is enabled on the simulated object, then the fracturecount
point attribute is created.
The point attribute fracturecount
maintains for each point, the number of times that the point has been involved in a fracture. So any point with a nonzero value of fracturecount
has been involved fracturing.
Name | Class | Type | Description |
---|---|---|---|
fracturecount
|
Point | Integer | The number of times a point was fractured during the simulation |
Legacy Attributes
In most situations where you want to influence a finite-element simulation, you will want to use soft constraints to achieve this, for example, target constraints, region constraints, or the target strength/damping settings on the object. These are first-class solver features that work in a stable way with the solver and should produce high quality results when used correctly. Purely for backwards compability, a force force attribute is still supported. Because the force force attribute lacks essential information that the solver needs, this attribute cannot be relied on when stability and quality are important. When setting up a new sim, alternatives such as soft targeting, region constraints and animated rest positions should be considered instead of the force force attribute.
Name | Class | Type | Description |
---|---|---|---|
fexternal
|
Force | Vector | External force density |
force
|
Force | Vector | Another name for external force density |
Locals
ST
This value is the simulation time for which the node is being evaluated.
This value may not be equal to the current Houdini time represented by the variable T, depending on the settings of the DOP Network Offset Time and Time Scale parameters.
This value is guaranteed to have a value of zero at the
start of a simulation, so when testing for the first timestep of a
simulation, it is best to use a test like $ST == 0
rather than
$T == 0
or $FF == 1
.
SF
This value is the simulation frame (or more accurately, the simulation time step number) for which the node is being evaluated.
This value may not be equal to the current Houdini frame number represented by the variable F, depending on the settings of the DOP Network parameters. Instead, this value is equal to the simulation time (ST) divided by the simulation timestep size (TIMESTEP).
TIMESTEP
This value is the size of a simulation timestep. This value is useful to scale values that are expressed in units per second, but are applied on each timestep.
SFPS
This value is the inverse of the TIMESTEP value. It is the number of timesteps per second of simulation time.
SNOBJ
This is the number of objects in the simulation. For nodes that create objects such as the Empty Object node, this value will increase for each object that is evaluated.
A good way to guarantee unique object names is to use an expression
like object_$SNOBJ
.
NOBJ
This value is the number of objects that will be evaluated by the current node during this timestep. This value will often be different from SNOBJ, as many nodes do not process all the objects in a simulation.
This value may return 0 if the node does not process each object sequentially (such as the Group DOP).
OBJ
This value is the index of the specific object being processed by the node. This value will always run from zero to NOBJ-1 in a given timestep. This value does not identify the current object within the simulation like OBJID or OBJNAME, just the object’s position in the current order of processing.
This value is useful for generating a random number for each object, or simply splitting the objects into two or more groups to be processed in different ways. This value will be -1 if the node does not process objects sequentially (such as the Group DOP).
OBJID
This is the unique object identifier for the object being processed. Every object is assigned an integer value that is unique among all objects in the simulation for all time. Even if an object is deleted, its identifier is never reused.
The object identifier can always be used to uniquely identify a given object. This makes this variable very useful in situations where each object needs to be treated differently. It can be used to produce a unique random number for each object, for example.
This value is also the best way to look up information on an object using the dopfield expression function. This value will be -1 if the node does not process objects sequentially (such as the Group DOP).
ALLOBJIDS
This string contains a space separated list of the unique object identifiers for every object being processed by the current node.
ALLOBJNAMES
This string contains a space separated list of the names of every object being processed by the current node.
OBJCT
This value is the simulation time (see variable ST) at which the current object was created.
Therefore, to check if an object was created
on the current timestep, the expression $ST == $OBJCT
should
always be used. This value will be zero if the node does not process
objects sequentially (such as the Group DOP).
OBJCF
This value is the simulation frame (see variable SF) at which the current object was created.
This value is equivalent to using the dopsttoframe expression on the OBJCT variable. This value will be zero if the node does not process objects sequentially (such as the Group DOP).
OBJNAME
This is a string value containing the name of the object being processed.
Object names are not guaranteed to be unique within a simulation. However, if you name your objects carefully so that they are unique, the object name can be a much easier way to identify an object than the unique object identifier, OBJID.
The object name can
also be used to treat a number of similar objects (with the same
name) as a virtual group. If there are 20 objects named "myobject",
specifying strcmp($OBJNAME, "myobject") == 0
in the activation field
of a DOP will cause that DOP to operate only on those 20 objects. This
value will be the empty string if the node does not process objects
sequentially (such as the Group DOP).
DOPNET
This is a string value containing the full path of the current DOP Network. This value is most useful in DOP subnet digital assets where you want to know the path to the DOP Network that contains the node.
Note
Most dynamics nodes have local variables with the same names as the node’s parameters. For example, in a Position node, you could write the expression:
$tx + 0.1
…to make the object move 0.1 units along the X axis at each timestep.
See also |