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

#include <plFadeOpacityMod.h>

Inheritance diagram for plFadeOpacityMod:
plSingleModifier plModifier plSynchedObject hsKeyedObject plCreatable

Public Types

enum  { kBoundsCenter = 0x1 }

Public Member Functions

 plFadeOpacityMod ()
virtual void read (hsStream *S, plResManager *mgr)
virtual void write (hsStream *S, plResManager *mgr)
float getFadeUp () const
float getFadeDown () const
void setFadeUp (float fade)
void setFadeDown (float fade)
- Public Member Functions inherited from plSingleModifier
bool getFlag (size_t flag) const
void setFlag (size_t flag, bool value)
virtual size_t getTargetsCount () const
virtual plKey getTarget (size_t) const
virtual void addTarget (plKey target)
virtual void removeTarget (plKey)

Protected Member Functions

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

Protected Attributes

float fFadeUp
float fFadeDown
- Protected Attributes inherited from plSingleModifier
hsBitVector fFlags
plKey fTarget

Member Enumeration Documentation

anonymous enum
Enumerator:
kBoundsCenter 

Constructor & Destructor Documentation

plFadeOpacityMod::plFadeOpacityMod ( )

Member Function Documentation

float plFadeOpacityMod::getFadeDown ( ) const
float plFadeOpacityMod::getFadeUp ( ) const
virtual void plFadeOpacityMod::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 plSingleModifier.

virtual void plFadeOpacityMod::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 plSingleModifier.

virtual void plFadeOpacityMod::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 plSingleModifier.

void plFadeOpacityMod::setFadeDown ( float  fade)
void plFadeOpacityMod::setFadeUp ( float  fade)
virtual void plFadeOpacityMod::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 plSingleModifier.

Member Data Documentation

float plFadeOpacityMod::fFadeDown
protected
float plFadeOpacityMod::fFadeUp
protected

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