Google

Main Page   Class Hierarchy   Compound List   File List   Compound 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.

virtual iMaterialWrapperGetMaterialWrapper () 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 iSkeletonStateGetSkeletonState () const=0
 Get the skeleton state. More...

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)=0
 Select an action.

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

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

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.

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

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

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


Detailed Description

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


Member Function Documentation

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.

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.

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.

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

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.

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


The documentation for this struct was generated from the following file:
Generated for Crystal Space by doxygen 1.2.5 written by Dimitri van Heesch, ©1997-2000