Unigine.AnimationBindMaterial Class
Warning
The functionality described here is EXPERIMENTAL and is not recommended for production use. Future releases may bring significant changes to API and features. Backward compatibility of the final production-ready version is not guaranteed.
| Inherits from: | AnimationBind |
This class is used to manage material bindings of animation objects via code. Animation objects serve as proxies in animation sequences and are bound to specific objects (materials, nodes, property parameters, or runtime objects like widgets and windows) at the playback stage.
Bindings are used to store, search, and obtain real engine objects that are actually animated.
The material to be animated can be bound either via the material asset or via an object's surface to which this material is assigned depending on the specified access mode. In case of accessing a material via a surface we'll get a child material inherited from the one assigned to this surface.
AnimationBindMaterial Class
Enums
ACCESS#
Access mode. Defines the way the animated material is obtained.Properties
AnimationBindMaterial.ACCESS Access#
The material access mode. Defines the way the animated material is obtained.
UGUID MaterialDescriptionGUID#
The GUID of the animated material.
UGUID MaterialDescriptionFileGUID#
The GUID of the file describing the animated material.
int ObjectDescriptionID#
The ID of the object, to which a surface with the animated material belongs.
string ObjectDescriptionName#
The name of the object, to which a surface with the animated material belongs.
string SurfaceDescriptionName#
The name of the surface, to which the animated material is assigned.
int SurfaceDescriptionIndex#
The number of the surface, to which the animated material is assigned.
Object Object#
The object to which the animated material is assigned.
Material Material#
The animated material.
Members
AnimationBindMaterial ( ) #
Constructor. Creates an empty material binding.void SetMaterialDescription ( UGUID guid, UGUID file_guid ) #
Sets the description parameters of the animated material. This method is used if the access mode is set to ACCESS.FROM_ASSETArguments
- UGUID guid - GUID of the animated material.
- UGUID file_guid - GUID of the file describing the animated material.
void SetObjectDescription ( int id, string name ) #
Sets the description parameters of the object to which a surface with the animated material belongs. This method is used if the access mode is set to ACCESS.FROM_SURFACE.Arguments
- int id - ID of the object, to which a surface with the animated material belongs.
- string name - Name of the object, to which a surface with the animated material belongs.
void SetSurfaceDescription ( string name, int index ) #
Sets the description parameters of the surface to which the animated material is assigned. This method is used if the access mode is set to ACCESS.FROM_SURFACEArguments
- string name - Name of the surface, to which the animated material is assigned.
- int index - Number of the surface, to which the animated material is assigned.
Last update:
2023-11-29
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)