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

#include <plViewFaceModifier.h>

Inheritance diagram for plViewFaceModifier:
plSingleModifier plModifier plSynchedObject hsKeyedObject plCreatable

Public Types

enum  plVFFlags {
  kPivotFace, kPivotFavorY, kPivotY, kPivotTumple,
  kScale, kFaceCam, kFaceList, kFacePlay,
  kFaceObj, kOffset, kOffsetLocal, kMaxBounds
}
enum  FollowMode { kFollowCamera, kFollowListener, kFollowPlayer, kFollowObject }

Public Member Functions

 plViewFaceModifier ()
virtual void read (hsStream *S, plResManager *mgr)
virtual void write (hsStream *S, plResManager *mgr)
hsVector3 getScale () const
hsVector3 getOffset () const
hsMatrix44 getLocalToParent () const
hsMatrix44 getParentToLocal () const
plKey getFaceObj () const
hsBounds3Ext getMaxBounds () const
void setScale (const hsVector3 &scale)
void setOffset (const hsVector3 &offset)
void setLocalToParent (const hsMatrix44 &l2p)
void setParentToLocal (const hsMatrix44 &p2l)
void setFaceObj (plKey obj)
void setMaxBounds (const hsBounds3Ext &bounds)
- 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

hsVector3 fScale
hsVector3 fOffset
hsMatrix44 fLocalToParent
hsMatrix44 fParentToLocal
plKey fFaceObj
hsBounds3Ext fMaxBounds
- Protected Attributes inherited from plSingleModifier
hsBitVector fFlags
plKey fTarget

Member Enumeration Documentation

Enumerator:
kFollowCamera 
kFollowListener 
kFollowPlayer 
kFollowObject 
Enumerator:
kPivotFace 
kPivotFavorY 
kPivotY 
kPivotTumple 
kScale 
kFaceCam 
kFaceList 
kFacePlay 
kFaceObj 
kOffset 
kOffsetLocal 
kMaxBounds 

Constructor & Destructor Documentation

plViewFaceModifier::plViewFaceModifier ( )

Member Function Documentation

plKey plViewFaceModifier::getFaceObj ( ) const
hsMatrix44 plViewFaceModifier::getLocalToParent ( ) const
hsBounds3Ext plViewFaceModifier::getMaxBounds ( ) const
hsVector3 plViewFaceModifier::getOffset ( ) const
hsMatrix44 plViewFaceModifier::getParentToLocal ( ) const
hsVector3 plViewFaceModifier::getScale ( ) const
virtual void plViewFaceModifier::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 plViewFaceModifier::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 plViewFaceModifier::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 plViewFaceModifier::setFaceObj ( plKey  obj)
void plViewFaceModifier::setLocalToParent ( const hsMatrix44 l2p)
void plViewFaceModifier::setMaxBounds ( const hsBounds3Ext bounds)
void plViewFaceModifier::setOffset ( const hsVector3 offset)
void plViewFaceModifier::setParentToLocal ( const hsMatrix44 p2l)
void plViewFaceModifier::setScale ( const hsVector3 scale)
virtual void plViewFaceModifier::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

plKey plViewFaceModifier::fFaceObj
protected
hsMatrix44 plViewFaceModifier::fLocalToParent
protected
hsBounds3Ext plViewFaceModifier::fMaxBounds
protected
hsVector3 plViewFaceModifier::fOffset
protected
hsMatrix44 plViewFaceModifier::fParentToLocal
protected
hsVector3 plViewFaceModifier::fScale
protected

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