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

#include <plATCAnim.h>

Inheritance diagram for plAGAnimBink:
plATCAnim plAGAnim plSynchedObject hsKeyedObject plCreatable

Public Member Functions

virtual void read (hsStream *S, plResManager *mgr)
virtual void write (hsStream *S, plResManager *mgr)
plString getBinkFilename () const
plString getSgtFilename () const
plString getSubtitleId () const
void setBinkFilename (const plString &filename)
void setSgtFilename (const plString &filename)
void setSubtitleId (const plString &id)
- Public Member Functions inherited from plATCAnim
 plATCAnim ()
const marker_tgetMarkers () const
marker_tgetMarkers ()
const loop_tgetLoops () const
loop_tgetLoops ()
float getInitial () const
float getLoopStart () const
float getLoopEnd () const
bool getAutoStart () const
bool getDoLoop () const
unsigned char getEaseInType () const
unsigned char getEaseOutType () const
float getEaseInLength () const
float getEaseInMin () const
float getEaseInMax () const
float getEaseOutLength () const
float getEaseOutMin () const
float getEaseOutMax () const
float getMarker (const plString &key) const
std::pair< float, float > getLoop (const plString &key) const
const std::vector< float > & getStops () const
void setInitial (float init)
void setLoopStart (float start)
void setLoopEnd (float end)
void setAutoStart (bool autoStart)
void setDoLoop (bool loop)
void setEaseInType (unsigned char type)
void setEaseOutType (unsigned char type)
void setEaseInParams (float length, float min, float max)
void setEaseOutParams (float length, float min, float max)
void setMarker (const plString &key, float value)
void setLoop (const plString &key, float start, float end)
void setStops (const std::vector< float > &stops)
- Public Member Functions inherited from plAGAnim
 plAGAnim ()
virtual ~plAGAnim ()
const std::vector
< plAGApplicator * > & 
getApplicators () const
std::vector< plAGApplicator * > & getApplicators ()
void addApplicator (plAGApplicator *app)
void delApplicator (size_t idx)
void clearApplicators ()
float getBlend () const
float getStart () const
float getEnd () const
plString getName () const
void setBlend (float blend)
void setStart (float start)
void setEnd (float end)
void setName (const plString &name)
- 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

plString fBinkFilename
plString fSgtFilename
plString fSubtitleId
- Protected Attributes inherited from plATCAnim
float fInitial
float fLoopStart
float fLoopEnd
bool fAutoStart
bool fLoop
unsigned char fEaseInType
unsigned char fEaseOutType
float fEaseInLength
float fEaseInMin
float fEaseInMax
float fEaseOutLength
float fEaseOutMin
float fEaseOutMax
marker_t fMarkers
loop_t fLoops
std::vector< float > fStopPoints
- Protected Attributes inherited from plAGAnim
std::vector< plAGApplicator * > fApps
float fBlend
float fStart
float fEnd
plString fName
unsigned char fEoaFlag
- Protected Attributes inherited from plSynchedObject
unsigned int fSynchFlags
std::vector< plStringfSDLExcludeList
std::vector< plStringfSDLVolatileList

Additional Inherited Members

- Public Types inherited from plATCAnim
typedef std::map< plString, float > marker_t
typedef std::map< plString,
std::pair< float, float > > 
loop_t

Member Function Documentation

plString plAGAnimBink::getBinkFilename ( ) const
plString plAGAnimBink::getSgtFilename ( ) const
plString plAGAnimBink::getSubtitleId ( ) const
virtual void plAGAnimBink::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 plATCAnim.

virtual void plAGAnimBink::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 plATCAnim.

virtual void plAGAnimBink::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 plATCAnim.

void plAGAnimBink::setBinkFilename ( const plString filename)
void plAGAnimBink::setSgtFilename ( const plString filename)
void plAGAnimBink::setSubtitleId ( const plString id)
virtual void plAGAnimBink::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 plATCAnim.

Member Data Documentation

plString plAGAnimBink::fBinkFilename
protected
plString plAGAnimBink::fSgtFilename
protected
plString plAGAnimBink::fSubtitleId
protected

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