Facebook Twitter YouTube

class Substance

Defined in:  TSMaterialObjects.h
The Substance class encapsulates a substance type.
Definition

class Substance : public MapElement<Substance>

Member Functions
Substance::GetPreviousRegisteredSubstance Returns the next registered substance.
Substance::GetNextRegisteredSubstance Returns the next registered substance.
Constructor

Substance(SubstanceType type, const char *name);

Parameters
type A unique 32-bit identifier that represents the type of the substance.
name The name of the substance that is displayed in the World Editor. The string to which this points must remain available in memory as int32 as the Substance object exists.
Description
The Substance class is used to hold information about a particular substance, such as wood or metal, that can be associated with a material object or a physics shape. An instance of the Substance class is typically created by the application for each different type of substance and registered with the engine by calling the MaterialObject::RegisterSubstance function. A subclass of the Substance class can be used to store additional application-specific information about each substance.
Base Classes
MapElement<Substance> Used internally.
See Also

MaterialObject::GetMaterialSubstance

MaterialObject::SetMaterialSubstance

MaterialObject::GetFirstRegisteredSubstance

MaterialObject::FindRegisteredSubstance

MaterialObject::RegisterSubstance

ShapeObject::GetShapeSubstance

ShapeObject::SetShapeSubstance