iSprite3DState Struct Reference
This interface describes the API for the 3D sprite mesh object. More...
#include <sprite3d.h>
Inheritance diagram for iSprite3DState:

Public Methods | |
virtual void | SetMaterialWrapper (iMaterialWrapper *material)=0 |
Set material of sprite. | |
virtual iMaterialWrapper * | GetMaterialWrapper () const=0 |
Get material of sprite. | |
virtual void | SetMixMode (uint mode)=0 |
Set mix mode. | |
virtual uint | GetMixMode () const=0 |
Get mix mode. | |
virtual void | SetLighting (bool l)=0 |
Set lighting. | |
virtual bool | IsLighting () const=0 |
Get lighting. | |
virtual void | SetFrame (int f)=0 |
Go to a specified frame. | |
virtual int | GetCurFrame () const=0 |
Get the current frame number. | |
virtual int | GetFrameCount () const=0 |
Get the number of frames. | |
virtual bool | SetAction (const char *name, bool loop=true, float speed=1)=0 |
Select an action by name. | |
virtual bool | SetAction (int index, bool loop=true, float speed=1)=0 |
Select an action by index. | |
virtual void | SetReverseAction (bool reverse)=0 |
Set whether action should run in reverse or not. | |
virtual void | SetSingleStepAction (bool singlestep)=0 |
Set single-step frame advance flag on actions. | |
virtual bool | SetOverrideAction (const char *name, float speed=1)=0 |
This sets an action to run one time, then the sprite reverts to the prior action. | |
virtual bool | SetOverrideAction (int index, float speed=1)=0 |
This sets an action to run one time, then the sprite reverts to the prior action. | |
virtual bool | PropagateAction (const char *name)=0 |
Propogate set action to all children. | |
virtual iSpriteAction * | GetCurAction () const=0 |
Get the current action. | |
virtual bool | GetReverseAction () const=0 |
Get whether the current action is reversed or not. | |
virtual void | EnableTweening (bool en)=0 |
Enable/disable tweening. | |
virtual bool | IsTweeningEnabled () const=0 |
Query state of tweening. | |
virtual void | UnsetTexture ()=0 |
Unset the texture (i.e. use the one from the factory). | |
virtual int | GetLightingQuality ()=0 |
Returns the lighting quality level used by this sprite. | |
virtual void | SetLocalLightingQuality (int lighting_quality)=0 |
Sets the local lighting quality for this sprite. | |
virtual void | SetLightingQualityConfig (int config_flag)=0 |
Sets which lighting config variable this sprite will use. | |
virtual int | GetLightingQualityConfig () const=0 |
Returns what this sprite is using for determining the lighting quality. | |
virtual void | SetLodLevelConfig (int config_flag)=0 |
Sets which lighting config variable this sprite will use. | |
virtual int | GetLodLevelConfig () const=0 |
Returns what this sprite is using for determining the lighting quality. | |
virtual bool | IsLodEnabled () const=0 |
Returns true if lod is enabled, else false. | |
virtual void | SetBaseColor (const csColor &col)=0 |
Set the base color. | |
virtual void | GetBaseColor (csColor &col) const=0 |
Get the base color. | |
virtual iSpriteSocket * | FindSocket (iMeshWrapper *mesh) const=0 |
find a socked based on the sprite attached to it. | |
virtual iSpriteSocket * | FindSocket (const char *name) const=0 |
find a named socket into the sprite. |
Detailed Description
This interface describes the API for the 3D sprite mesh object.
Definition at line 322 of file sprite3d.h.
Member Function Documentation
|
Enable/disable tweening.
|
|
find a named socket into the sprite.
|
|
find a socked based on the sprite attached to it.
|
|
Get the base color.
|
|
Get the current action.
|
|
Get the current frame number.
|
|
Get the number of frames.
|
|
Returns the lighting quality level used by this sprite. See SPR_LIGHTING_* macros defined in this header for the different types of lighting. |
|
Returns what this sprite is using for determining the lighting quality.
|
|
Returns what this sprite is using for determining the lighting quality.
|
|
Get material of sprite.
|
|
Get mix mode.
|
|
Get whether the current action is reversed or not.
|
|
Get lighting.
|
|
Returns true if lod is enabled, else false.
|
|
Query state of tweening.
|
|
Propogate set action to all children.
|
|
Select an action by index. If 'loop'==false the animation will not loop. |
|
Select an action by name. If 'loop'==false the animation will not loop. |
|
Set the base color. This color will be added to the vertex colors of the sprite. If no lighting is used then this will be the color. |
|
Go to a specified frame.
|
|
Set lighting.
|
|
Sets which lighting config variable this sprite will use. The options are:
|
|
Sets the local lighting quality for this sprite. NOTE: you must use SetLightingQualityConfig (CS_SPR_LIGHT_LOCAL) for the sprite to use this. |
|
Sets which lighting config variable this sprite will use. The options are:
|
|
Set material of sprite.
|
|
Set mix mode.
|
|
This sets an action to run one time, then the sprite reverts to the prior action.
|
|
This sets an action to run one time, then the sprite reverts to the prior action.
|
|
Set whether action should run in reverse or not.
|
|
Set single-step frame advance flag on actions.
|
|
Unset the texture (i.e. use the one from the factory).
|
The documentation for this struct was generated from the following file:
- imesh/sprite3d.h
Generated for Crystal Space by doxygen 1.2.18