1.7.3Please send us your comment about this page
Functions |
|
| PFExport | IParticleChannel () |
| PFExport | IParticleChannel (const Interface_ID &readID, const Interface_ID &writeID) |
| virtual Class_ID | GetClassID () const =0 |
| Returns the unique ID for the channel class.
|
|
| virtual IObject * | Clone () const =0 |
| cloning; make a copy of the channel |
|
| virtual IOResult | Save (ISave *isave) const =0 |
| saving content of the channel to file
|
|
| virtual IOResult | Load (ILoad *iload)=0 |
| loading content of the channel from file
|
|
| PFExport bool | IsSimilarChannel (IObject *channel) const |
| checks if the given IObject is a similar particle channel
|
|
| PFExport bool | IsTransferable () const |
| Get "transferable" status. |
|
| PFExport void | SetTransferable (bool status) |
| Set "transferable" status. |
|
| PFExport bool | IsPrivateChannel () const |
| A channel can be declared "private" by an
action. |
|
| PFExport Object * | GetPrivateOwner () const |
| returns a "private owner" action of the
channel |
|
| PFExport void | SetPrivateOwner (Object *action) |
| sets a "private owner" action of the channel
|
|
| PFExport INode * | GetCreatorAction () const |
| channel data can be viewed by different
actions. |
|
| PFExport void | SetCreatorAction (INode *actionNode) |
| channel data can be viewed by different
actions. |
|
| PFExport DWORD | GetReadID_PartA () const |
| Set/get a concrete channel ID for a generic
data particle channel. |
|
| PFExport DWORD | GetReadID_PartB () const |
| Set/get a concrete channel ID for a generic
data particle channel. |
|
| PFExport DWORD | GetWriteID_PartA () const |
| access write-interface ID of the wrapping
channel |
|
| PFExport DWORD | GetWriteID_PartB () const |
| access write-interface ID of the wrapping
channel |
|
| PFExport void | SetReadID (DWORD interfaceID_PartA, DWORD interfaceID_PartB) |
| set up read-interface ID of the wrapping
channel |
|
| PFExport void | SetWriteID (DWORD interfaceID_PartA, DWORD interfaceID_PartB) |
| set up write-interface ID of the wrapping
channel |
|
| PFExport const Interface_ID & | GetReadID () const |
| methods that are not in FnPub interface.
|
|
| PFExport const Interface_ID & | GetWriteID () const |
| access write-interface ID of the wrapping
channel |
|
| PFExport void | SetReadID (const Interface_ID &id) |
| set up read-interface ID of the wrapping
channel |
|
| PFExport void | SetWriteID (const Interface_ID &id) |
| set up write-interface ID of the wrapping
channel |
|
| PFExport void | CloneChannelCore (IParticleChannel *getFrom) |
| when cloning a channel, data about
transferable, privateOwner, creatorAction, readID & write ID
should be cloned. |
|
| PFExport void | UpdateCreatorHandle (IMergeManager *pMM) |
| when cached channel data are merged the
stored action creator handle could be invalid. |
|
| virtual int | MemoryUsed () const =0 |
| returns amount of memory used (in bytes) by
the channel to store the information |
|
| FPInterfaceDesc * | GetDesc () |
| int | numRefs () const |
| int & | _numRefs () |
Variables |
|
| bool | m_isTransferable |
| bool | m_isPrivate |
| Object * | m_privateOwner |
| INode * | m_creatorAction |
| ULONG | m_creatorHandle |
| Interface_ID | m_readID |
| Interface_ID | m_writeID |
| PFExport IParticleChannel | ( | ) | [inherited] |
| PFExport IParticleChannel | ( | const Interface_ID & | readID, |
| const Interface_ID & | writeID | ||
| ) | [inherited] |
| Class_ID GetClassID | ( | ) | const [pure virtual, inherited] |
Returns the unique ID for the channel class.
The ID is used for constructing the channel when loading since the channel class is not inherited from class Animatable.
| IObject * Clone | ( | ) | const [pure virtual, inherited] |
cloning; make a copy of the channel
saving content of the channel to file
loading content of the channel from file
| PFExport bool IsSimilarChannel | ( | IObject * | channel | ) | const [inherited] |
checks if the given IObject is a similar particle channel
| PFExport bool IsTransferable | ( | ) | const [inherited] |
Get "transferable" status.
If particle channel is transferable then it is transferred from one event to another; the data in the channel are glued to particles if particle channel is not transferable then while particles moves to another event, the particle channel is not
| PFExport void SetTransferable | ( | bool | status | ) | [inherited] |
Set "transferable" status.
| PFExport bool IsPrivateChannel | ( | ) | const [inherited] |
A channel can be declared "private" by an action.
when a channel is declared as a "private" a reference on a "private owner" is given then only the "private owner" action will be given access to this channel. the technique allows creating several channels with the same data-type (for example, position) in the container by different "private owner" actions Because of access to particle container, onle an action that created the channel can declare itself as a private owner.
| PFExport Object * GetPrivateOwner | ( | ) | const [inherited] |
returns a "private owner" action of the channel
| PFExport void SetPrivateOwner | ( | Object * | action | ) | [inherited] |
sets a "private owner" action of the channel
| PFExport INode * GetCreatorAction | ( | ) | const [inherited] |
channel data can be viewed by different actions.
however an action that created the channel is responsible for data initialization. therefore the action has to keep track how (by what action) the channel was created
| PFExport void SetCreatorAction | ( | INode * | actionNode | ) | [inherited] |
channel data can be viewed by different actions.
however an action that created the channel is responsible for data initialization. therefore the action has to keep track how (by what action) the channel was created
| PFExport DWORD GetReadID_PartA | ( | ) | const [inherited] |
Set/get a concrete channel ID for a generic data particle channel.
Access read-interface ID of the wrapping channel.
| PFExport DWORD GetReadID_PartB | ( | ) | const [inherited] |
Set/get a concrete channel ID for a generic data particle channel.
Access read-interface ID of the wrapping channel.
| PFExport DWORD GetWriteID_PartA | ( | ) | const [inherited] |
access write-interface ID of the wrapping channel
| PFExport DWORD GetWriteID_PartB | ( | ) | const [inherited] |
access write-interface ID of the wrapping channel
| PFExport void SetReadID | ( | DWORD | interfaceID_PartA, |
| DWORD | interfaceID_PartB | ||
| ) | [inherited] |
set up read-interface ID of the wrapping channel
| PFExport void SetWriteID | ( | DWORD | interfaceID_PartA, |
| DWORD | interfaceID_PartB | ||
| ) | [inherited] |
set up write-interface ID of the wrapping channel
| PFExport const Interface_ID & GetReadID | ( | ) | const [inherited] |
methods that are not in FnPub interface.
Access read-interface ID of the wrapping channel.
| PFExport const Interface_ID & GetWriteID | ( | ) | const [inherited] |
access write-interface ID of the wrapping channel
| PFExport void SetReadID | ( | const Interface_ID & | id | ) | [inherited] |
set up read-interface ID of the wrapping channel
| PFExport void SetWriteID | ( | const Interface_ID & | id | ) | [inherited] |
set up write-interface ID of the wrapping channel
| PFExport void CloneChannelCore | ( | IParticleChannel * | getFrom | ) | [inherited] |
when cloning a channel, data about transferable, privateOwner, creatorAction, readID & write ID should be cloned.
the following method does that: it clones the core data from the given channel
| PFExport void UpdateCreatorHandle | ( | IMergeManager * | pMM | ) | [inherited] |
when cached channel data are merged the stored action creator handle could be invalid.
the method lets the channel to update the action handle to the proper one
| int MemoryUsed | ( | ) | const [pure virtual, inherited] |
returns amount of memory used (in bytes) by the channel to store the information
| FPInterfaceDesc * GetDesc | ( | ) | [inline, virtual, inherited] |
Implements FPInterface.
{ return GetDescByID(PARTICLECHANNEL_INTERFACE); }
| int numRefs | ( | ) | const [inline, protected, inherited] |
{ return m_numRefs; }
| int& _numRefs | ( | ) | [inline, protected, inherited] |
{ return m_numRefs; }
bool m_isTransferable [protected,
inherited] |
bool m_isPrivate [protected,
inherited] |
Object* m_privateOwner [mutable,
protected, inherited] |
INode* m_creatorAction [mutable,
protected, inherited] |
ULONG m_creatorHandle [protected,
inherited] |
Interface_ID m_readID
[protected, inherited] |
Interface_ID m_writeID
[protected, inherited] |