Detailed Description
Represents a particle type. A particle type serves as a definition of the particles on the initial state of a particle simulation.
A particle cloud contains one or more particle type(s). All particle types in a scene can be found under Scene.Particles container.
- See also:
- ParticleCloud, ParticleCloudPrimitive, X3DObject::AddParticleCloud, ParticleAttribute
- Since:
- 4.0
- Deprecated:
- 8.0 (2010) Legacy particles are only kept for backward compatibility.
- Example:
- Creates the initial state with a user defined particle attribute for a particle simulation
#include <xsi_particletype.h>
List of all members.
Constructor & Destructor Documentation
Constructor.
- Parameters:
-
in_ref | constant reference object. |
Copy constructor.
- Parameters:
-
in_obj | constant class object. |
Member Function Documentation
bool IsA |
( |
siClassID |
in_ClassID | ) |
const [virtual] |
Returns true if a given class type is compatible with this API class.
- Parameters:
-
- Returns:
- true if the class is compatible, false otherwise.
Reimplemented from Property.
Returns the type of the API class.
- Returns:
- The class type.
Reimplemented from Property.
Creates an object from another object. The newly created object is set to empty if the input object is not compatible.
- Parameters:
-
in_obj | constant class object. |
- Returns:
- The new ParticleType object.
Creates an object from a reference object. The newly created object is set to empty if the input reference object is not compatible.
- Parameters:
-
in_ref | constant class object. |
- Returns:
- The new ParticleType object.
Reimplemented from Property.
Returns the scene index for this particle type, which corresponds to the index of this particle type under the Scene.Particles container.
- Returns:
- The ParticleType ID.
Adds a new user-defined attribute to this particle type. You must specify a type (ParticleAttribute.GetAttributeType) and a unique name for the new attribute. This function fails if another user-defined attribute with the same name exists.
- Parameters:
-
in_name | name of the defined attribute |
in_type | type of the defined attribute |
- Returns:
- CStatus::OK success
-
CStatus::Fail other failure
-
CStatus::InvalidArgument if in_type is siPAUndefined
Removes a user-defined attribute from this particle type by specifying the name.
- Parameters:
-
in_name | name of the attribute to remove. |
- Returns:
- CStatus::OK success
-
CStatus::Fail other failure
-
CStatus::False the attribute of name in_name was not found on the ParticleType.
Returns an array containing the names of all user-defined attributes for this particle type.
- Returns:
- Array of custom attribute names.
Returns the data type of the specified attribute. If no attribute matches the specified name, it returns siPAUndefined.
- Parameters:
-
in_name | name of the attribute to remove. |
- Returns:
- Type of a given attribute.
-
siPAUndefined if no match is found
The documentation for this class was generated from the following file: