CrystalSpace

Public API Reference

Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

iSprite3DState Struct Reference

This interface describes the API for the 3D sprite mesh object. More...

#include <sprite3d.h>

Inheritance diagram for iSprite3DState:

iBase List of all members.

Public Methods

virtual void SetMaterialWrapper (iMaterialWrapper *material)=0
 Set material of sprite. More...

virtual iMaterialWrapperGetMaterialWrapper () const=0
 Get material of sprite. More...

virtual void SetMixMode (uint mode)=0
 Set mix mode. More...

virtual uint GetMixMode () const=0
 Get mix mode. More...

virtual void SetLighting (bool l)=0
 Set lighting. More...

virtual bool IsLighting () const=0
 Get lighting. More...

virtual iSkeletonStateGetSkeletonState () const=0
 Get the skeleton state. More...

virtual void SetFrame (int f)=0
 Go to a specified frame. More...

virtual int GetCurFrame () const=0
 Get the current frame number. More...

virtual int GetFrameCount () const=0
 Get the number of frames. More...

virtual bool SetAction (const char *name, bool loop=true, float speed=1)=0
 Select an action. More...

virtual void SetReverseAction (bool reverse)=0
 Set whether action should run in reverse or not. More...

virtual void SetSingleStepAction (bool singlestep)=0
 Set single-step frame advance flag on actions. More...

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. More...

virtual bool PropagateAction (const char *name)=0
 Propogate set action to all children. More...

virtual iSpriteActionGetCurAction () const=0
 Get the current action. More...

virtual bool GetReverseAction () const=0
 Get whether the current action is reversed or not. More...

virtual void EnableTweening (bool en)=0
 Enable/disable tweening. More...

virtual bool IsTweeningEnabled () const=0
 Query state of tweening. More...

virtual void UnsetTexture ()=0
 Unset the texture (i.e. use the one from the factory). More...

virtual int GetLightingQuality ()=0
 Returns the lighting quality level used by this sprite. More...

virtual void SetLocalLightingQuality (int lighting_quality)=0
 Sets the local lighting quality for this sprite. More...

virtual void SetLightingQualityConfig (int config_flag)=0
 Sets which lighting config variable this sprite will use. More...

virtual int GetLightingQualityConfig () const=0
 Returns what this sprite is using for determining the lighting quality. More...

virtual void SetLodLevelConfig (int config_flag)=0
 Sets which lighting config variable this sprite will use. More...

virtual int GetLodLevelConfig () const=0
 Returns what this sprite is using for determining the lighting quality. More...

virtual bool IsLodEnabled () const=0
 Returns true if lod is enabled, else false. More...

virtual void SetBaseColor (const csColor &col)=0
 Set the base color. More...

virtual void GetBaseColor (csColor &col) const=0
 Get the base color. More...

virtual iSpriteSocketFindSocket (iMeshWrapper *mesh) const=0
 find a socked based on the sprite attached to it. More...

virtual iSpriteSocketFindSocket (const char *name) const=0
 find a named socket into the sprite. More...


Detailed Description

This interface describes the API for the 3D sprite mesh object.

Definition at line 335 of file sprite3d.h.


Member Function Documentation

virtual void iSprite3DState::EnableTweening bool    en [pure virtual]
 

Enable/disable tweening.

virtual iSpriteSocket* iSprite3DState::FindSocket const char *    name const [pure virtual]
 

find a named socket into the sprite.

virtual iSpriteSocket* iSprite3DState::FindSocket iMeshWrapper   mesh const [pure virtual]
 

find a socked based on the sprite attached to it.

virtual void iSprite3DState::GetBaseColor csColor   col const [pure virtual]
 

Get the base color.

virtual iSpriteAction* iSprite3DState::GetCurAction   const [pure virtual]
 

Get the current action.

virtual int iSprite3DState::GetCurFrame   const [pure virtual]
 

Get the current frame number.

virtual int iSprite3DState::GetFrameCount   const [pure virtual]
 

Get the number of frames.

virtual int iSprite3DState::GetLightingQuality   [pure virtual]
 

Returns the lighting quality level used by this sprite.

See SPR_LIGHTING_* macros defined in this header for the different types of lighting.

virtual int iSprite3DState::GetLightingQualityConfig   const [pure virtual]
 

Returns what this sprite is using for determining the lighting quality.

virtual int iSprite3DState::GetLodLevelConfig   const [pure virtual]
 

Returns what this sprite is using for determining the lighting quality.

virtual iMaterialWrapper* iSprite3DState::GetMaterialWrapper   const [pure virtual]
 

Get material of sprite.

virtual uint iSprite3DState::GetMixMode   const [pure virtual]
 

Get mix mode.

virtual bool iSprite3DState::GetReverseAction   const [pure virtual]
 

Get whether the current action is reversed or not.

virtual iSkeletonState* iSprite3DState::GetSkeletonState   const [pure virtual]
 

Get the skeleton state.

Will only be valid if skeletal animation has been enabled for the factory that this sprite was created from. Otherwise it will return NULL.

virtual bool iSprite3DState::IsLighting   const [pure virtual]
 

Get lighting.

virtual bool iSprite3DState::IsLodEnabled   const [pure virtual]
 

Returns true if lod is enabled, else false.

virtual bool iSprite3DState::IsTweeningEnabled   const [pure virtual]
 

Query state of tweening.

virtual bool iSprite3DState::PropagateAction const char *    name [pure virtual]
 

Propogate set action to all children.

virtual bool iSprite3DState::SetAction const char *    name,
bool    loop = true,
float    speed = 1
[pure virtual]
 

Select an action.

If 'loop'==false the animation will not loop.

virtual void iSprite3DState::SetBaseColor const csColor   col [pure virtual]
 

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.

virtual void iSprite3DState::SetFrame int    f [pure virtual]
 

Go to a specified frame.

virtual void iSprite3DState::SetLighting bool    l [pure virtual]
 

Set lighting.

virtual void iSprite3DState::SetLightingQualityConfig int    config_flag [pure virtual]
 

Sets which lighting config variable this sprite will use.

The options are:

  • CS_SPR_LIGHT_GLOBAL (default)
  • CS_SPR_LIGHT_TEMPLATE
  • CS_SPR_LIGHT_LOCAL

virtual void iSprite3DState::SetLocalLightingQuality int    lighting_quality [pure virtual]
 

Sets the local lighting quality for this sprite.

NOTE: you must use SetLightingQualityConfig (CS_SPR_LIGHT_LOCAL) for the sprite to use this.

virtual void iSprite3DState::SetLodLevelConfig int    config_flag [pure virtual]
 

Sets which lighting config variable this sprite will use.

The options are:

  • CS_SPR_LOD_GLOBAL (default)
  • CS_SPR_LOD_TEMPLATE
  • CS_SPR_LOD_LOCAL

virtual void iSprite3DState::SetMaterialWrapper iMaterialWrapper   material [pure virtual]
 

Set material of sprite.

virtual void iSprite3DState::SetMixMode uint    mode [pure virtual]
 

Set mix mode.

virtual bool iSprite3DState::SetOverrideAction const char *    name,
float    speed = 1
[pure virtual]
 

This sets an action to run one time, then the sprite reverts to the prior action.

virtual void iSprite3DState::SetReverseAction bool    reverse [pure virtual]
 

Set whether action should run in reverse or not.

virtual void iSprite3DState::SetSingleStepAction bool    singlestep [pure virtual]
 

Set single-step frame advance flag on actions.

virtual void iSprite3DState::UnsetTexture   [pure virtual]
 

Unset the texture (i.e. use the one from the factory).


The documentation for this struct was generated from the following file:
Generated for Crystal Space by doxygen 1.2.14