libHSPlasma
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
plSpotLightInfo Class Reference

#include <plOmniLightInfo.h>

Inheritance diagram for plSpotLightInfo:
plOmniLightInfo plLightInfo plObjInterface plSynchedObject hsKeyedObject plCreatable

Public Member Functions

 plSpotLightInfo ()
virtual void read (hsStream *S, plResManager *mgr)
virtual void write (hsStream *S, plResManager *mgr)
float getFalloff () const
float getSpotInner () const
float getSpotOuter () const
void setFalloff (float falloff)
void setSpotInner (float spot)
void setSpotOuter (float spot)
- Public Member Functions inherited from plOmniLightInfo
 plOmniLightInfo ()
float getAttenConst () const
float getAttenLinear () const
float getAttenQuadratic () const
float getAttenCutoff () const
void setAttenConst (float atten)
void setAttenLinear (float atten)
void setAttenQuadratic (float atten)
void setAttenCutoff (float cutoff)
- Public Member Functions inherited from plLightInfo
 plLightInfo ()
hsColorRGBA getAmbient () const
hsColorRGBA getDiffuse () const
hsColorRGBA getSpecular () const
hsMatrix44 getLightToLocal () const
hsMatrix44 getLocalToLight () const
hsMatrix44 getLightToWorld () const
hsMatrix44 getWorldToLight () const
plKey getProjection () const
plKey getSoftVolume () const
plKey getSceneNode () const
void setAmbient (const hsColorRGBA &color)
void setDiffuse (const hsColorRGBA &color)
void setSpecular (const hsColorRGBA &color)
void setLightToLocal (const hsMatrix44 &xform)
void setLocalToLight (const hsMatrix44 &xform)
void setLightToWorld (const hsMatrix44 &xform)
void setWorldToLight (const hsMatrix44 &xform)
void setProjection (plKey proj)
void setSoftVolume (plKey vol)
void setSceneNode (plKey node)
const std::vector< plKey > & getVisRegions () const
std::vector< plKey > & getVisRegions ()
void addVisRegion (plKey region)
void delVisRegion (size_t idx)
void clearVisRegions ()
- Public Member Functions inherited from plObjInterface
 plObjInterface ()
bool getProperty (size_t prop) const
void setProperty (size_t prop, bool value)
plKey getOwner () const
void setOwner (plKey owner)
- Public Member Functions inherited from plSynchedObject
 plSynchedObject ()
int getFlags () const
void setFlags (int flags)
const std::vector< plString > & getExcludes () const
const std::vector< plString > & getVolatiles () const
void setExclude (const plString &sdl)
void setVolatile (const plString &sdl)
void clearExcludes ()
void clearVolatiles ()
- Public Member Functions inherited from hsKeyedObject
void init (const plString &name)
plKey getKey () const
void setKey (plKey key)
- Public Member Functions inherited from plCreatable
 plCreatable ()
virtual ~plCreatable ()
virtual short ClassIndex () const =0
short ClassIndex (PlasmaVer ver) const
virtual const char * ClassName () const
virtual bool ClassInstance (short) const
virtual bool isStub () const
virtual void prcWrite (pfPrcHelper *prc)
virtual void prcParse (const pfPrcTag *tag, plResManager *mgr)

Protected Member Functions

virtual void IPrcWrite (pfPrcHelper *prc)
virtual void IPrcParse (const pfPrcTag *tag, plResManager *mgr)

Protected Attributes

float fFalloff
float fSpotInner
float fSpotOuter
- Protected Attributes inherited from plOmniLightInfo
float fAttenConst
float fAttenLinear
float fAttenQuadratic
float fAttenCutoff
- Protected Attributes inherited from plLightInfo
std::vector< plKeyfVisRegions
hsColorRGBA fAmbient
hsColorRGBA fDiffuse
hsColorRGBA fSpecular
hsMatrix44 fLightToLocal
hsMatrix44 fLocalToLight
hsMatrix44 fLightToWorld
hsMatrix44 fWorldToLight
plKey fProjection
plKey fSoftVolume
plKey fSceneNode
- Protected Attributes inherited from plObjInterface
plKey fOwner
hsBitVector fProps
- Protected Attributes inherited from plSynchedObject
unsigned int fSynchFlags
std::vector< plStringfSDLExcludeList
std::vector< plStringfSDLVolatileList

Additional Inherited Members

- Public Types inherited from plLightInfo
enum  {
  kDisable, kLPObsolete, kLPCastShadows, kLPMovable,
  kLPHasIncludes, kLPIncludesChars, kLP_OBSOLECTE_0, kLPOverAll,
  kLPHasSpecular, kLPShadowOnly, kLPShadowLightGroup, kLPForceProj,
  kNumProps
}

Constructor & Destructor Documentation

plSpotLightInfo::plSpotLightInfo ( )

Member Function Documentation

float plSpotLightInfo::getFalloff ( ) const
float plSpotLightInfo::getSpotInner ( ) const
float plSpotLightInfo::getSpotOuter ( ) const
virtual void plSpotLightInfo::IPrcParse ( const pfPrcTag tag,
plResManager mgr 
)
protectedvirtual

This must be overloaded by subclasses to parse PRC data specific to the class from the PRC document. It is called once for each tag that is a child to the Creatable tag itself, so subclasses should check for each supported tag and handle it accordingly if it matches. If the tag is not recognized, it should be passed along to the parent class.

Reimplemented from plOmniLightInfo.

virtual void plSpotLightInfo::IPrcWrite ( pfPrcHelper prc)
protectedvirtual

This must be overloaded by subclasses to write PRC data specific to the class to the PRC document. Do not write the top-level creatable tag, that is handled by prcWrite().

Reimplemented from plOmniLightInfo.

virtual void plSpotLightInfo::read ( hsStream ,
plResManager  
)
virtual

Reads this creatable directly from the stream. If any keys are read, they will be added to the plResManager automatically.

Reimplemented from plOmniLightInfo.

void plSpotLightInfo::setFalloff ( float  falloff)
void plSpotLightInfo::setSpotInner ( float  spot)
void plSpotLightInfo::setSpotOuter ( float  spot)
virtual void plSpotLightInfo::write ( hsStream ,
plResManager  
)
virtual

Writes this creatable directly to the stream. The plResManager is used to manage any key references written by this creatable.

Reimplemented from plOmniLightInfo.

Member Data Documentation

float plSpotLightInfo::fFalloff
protected
float plSpotLightInfo::fSpotInner
protected
float plSpotLightInfo::fSpotOuter
protected

The documentation for this class was generated from the following file: