#include <plAnimStage.h>
Public Types |
| enum | NotifyType { kNotifyEnter = 0x1,
kNotifyLoop = 0x2,
kNotifyAdvance = 0x4,
kNotifyRegress = 0x8
} |
| enum | PlayType { kPlayNone,
kPlayKey,
kPlayAuto,
kPlayMax
} |
| enum | AdvanceType {
kAdvanceNone,
kAdvanceOnMove,
kAdvanceAuto,
kAdvanceOnAnyKey,
kAdvanceMax
} |
Member Enumeration Documentation
- Enumerator:
| kAdvanceNone |
|
| kAdvanceOnMove |
|
| kAdvanceAuto |
|
| kAdvanceOnAnyKey |
|
| kAdvanceMax |
|
- Enumerator:
| kNotifyEnter |
|
| kNotifyLoop |
|
| kNotifyAdvance |
|
| kNotifyRegress |
|
- Enumerator:
| kPlayNone |
|
| kPlayKey |
|
| kPlayAuto |
|
| kPlayMax |
|
Constructor & Destructor Documentation
| plAnimStage::plAnimStage |
( |
| ) |
|
Member Function Documentation
| bool plAnimStage::doAdvanceTo |
( |
| ) |
const |
| bool plAnimStage::doRegressTo |
( |
| ) |
const |
| unsigned int plAnimStage::getAdvanceTo |
( |
| ) |
const |
| plString plAnimStage::getAnimName |
( |
| ) |
const |
| PlayType plAnimStage::getBackType |
( |
| ) |
const |
| int plAnimStage::getCurLoop |
( |
| ) |
const |
| PlayType plAnimStage::getForwardType |
( |
| ) |
const |
| float plAnimStage::getLength |
( |
| ) |
const |
| float plAnimStage::getLocalTime |
( |
| ) |
const |
| int plAnimStage::getLoops |
( |
| ) |
const |
| unsigned char plAnimStage::getNotify |
( |
| ) |
const |
| unsigned int plAnimStage::getRegressTo |
( |
| ) |
const |
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 plCreatable.
| virtual void plAnimStage::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().
Implements plCreatable.
| bool plAnimStage::isAttached |
( |
| ) |
const |
| void plAnimStage::prcParseAux |
( |
const pfPrcTag * |
tag | ) |
|
Reads this creatable directly from the stream. If any keys are read, they will be added to the plResManager automatically.
Reimplemented from plCreatable.
| void plAnimStage::readAux |
( |
hsStream * |
S | ) |
|
| void plAnimStage::setAdvanceTo |
( |
bool |
doAdvance, |
|
|
unsigned int |
advance = 0 |
|
) |
| |
| void plAnimStage::setAnimName |
( |
const plString & |
name | ) |
|
| void plAnimStage::setAttached |
( |
bool |
att | ) |
|
| void plAnimStage::setBackType |
( |
PlayType |
back | ) |
|
| void plAnimStage::setCurLoop |
( |
int |
loop | ) |
|
| void plAnimStage::setForwardType |
( |
PlayType |
fwd | ) |
|
| void plAnimStage::setLength |
( |
float |
length | ) |
|
| void plAnimStage::setLocalTime |
( |
float |
time | ) |
|
| void plAnimStage::setLoops |
( |
int |
loops | ) |
|
| void plAnimStage::setNotify |
( |
unsigned char |
notify | ) |
|
| void plAnimStage::setRegressTo |
( |
bool |
doRegress, |
|
|
unsigned int |
regress = 0 |
|
) |
| |
Writes this creatable directly to the stream. The plResManager is used to manage any key references written by this creatable.
Reimplemented from plCreatable.
| void plAnimStage::writeAux |
( |
hsStream * |
S | ) |
|
The documentation for this class was generated from the following file:
Public Member Functions inherited from plCreatable