the instance of EntityRepository
the entity unique Id which this component belongs to
the instance of MemoryManager
Get the Scoped ID of the Component
Get the current process stage of the component.
get the entity which has this component.
the entity which has this component
Get the unique ID of the entity corresponding to the component.
return a copy of an inverse local transform matrix
return an inverse local transform matrix
return a local transform matrix
Get the max number of components
Gets the objectUID of the object.
return a copy of a local quaternion vector
return a local quaternion vector
return a local rotation (XYZ euler) vector
return a local scale vector
return a local translate vector
Get the unique name of the entity.
the target entity
the component class to add
get the bytes Information of the member
the member of component in string
bytes information
Gets the tag object.
The tag name.
Gets the value of the tag.
The tag name.
Gets the boolean value whether this object has the tag or not.
The tag name.
Get true or false whether the specified ProcessStage exists in Component.
Confirms the matching of the tag name and tag value.
The tag name.
The tag value.
Confirm that this object's tags includes given set of tags.
The set of tags.
Confirm that this object's tags includes given an array of string.
an array of string.
Move to the other stages of process
stage of component's process
register a dependency for the other components. Note: This method is not used yet
Register a member field of component class for memory allocation.
purpose type of buffer use
the name of member field
a class of data
a type of number
a initial value
Remove the tag.
The tag name.
Set multiple transform information at once. By using this method, we reduce the cost of automatically updating other transform components inside this class. This method may be useful for animation processing and so on.
The transform components of these arguments must not be mutually discrepant. for example. The transform components of matrix argument (translate, rotate/quaternion, scale) must be equal to translate, rotate, scale, quaternion arguments. And both rotate and quaternion arguments must be same rotation. If there is an argument passed with null or undefined, it is interpreted as unchanged.
Allocate memory of self member fields
a number of entities to need allocate
take one memory area for the specified member for all same type of the component instances.
Tries to set tag (name and value).
Try to set a unique name of the entity.
If true, force to add name string to the current unique name string. If false, give up to change name.
Validate the string of tags.
The string to be validated
Get true or false whether the specified ProcessStage exists in Component.
true or false
get the taken accessor for the member field.
get byte length of sum of member fields in the component class
Get the ComponentType of the member
the member name
the component class
ComponentType or undefined
Get the CompositionType of the member
the member name
the component class
CompositionType or undefined
get the bytes Information of the member (static version) by ComponentSID
the Component type
the ComponentSID of the component
the member of component in string
bytes information
get the bytes Information of the member (static version) by EntityUID
the component type
the EntityUID
the member of component in string
bytes information
get the bytes Information of the member
a instance of the component
the member of component in string
bytes information
get the Pixel Location Offset in the Buffer of the Member
the component type (e.g. TransformComponent )
the member name in string
the pixel offsets
Gets the object by corresponding to the objectUID.
The objectUID of the object.
Gets the object by the unique name.
The unique name of the object.
Process the components
params
take one accessor for the member field.
Update all components at each process stage.
Generated using TypeDoc
The constructor of the Component class. When creating an Component, use the createComponent method of the ComponentRepository class instead of directly calling this constructor.