IPFAction.h File Reference
Action-generic interface IPFAction. More...
#include "PFExport.h"#include "ParticleChannelMask.h"#include "..\ifnpub.h"#include "..\object.h"Go to the source code of this file.
Classes |
|
| class | IPFAction |
Defines |
|
| #define | PFACTION_INTERFACE Interface_ID(0x74f93d00, 0x1eb34500) |
| #define | GetPFActionInterface(obj) ((IPFAction*)((GetPFObject(obj))->GetInterface(PFACTION_INTERFACE))) |
| #define | PROPID_FINALUPDATETIME 0x00635690 |
Enumerations |
|
| enum | { kPF_GetActionDescription = 781, kPF_GetActionName, kPF_PViewPublic, kPF_PViewCategory, kPF_IsFertile, kPF_IsNonExecutable, kPF_PViewDepotIcon } |
Functions |
|
| PFExport Object * | GetPFObject (Object *obj) |
| IPFAction * | PFActionInterface (Object *obj) |
| IPFAction * | PFActionInterface (INode *node) |
| PFExport int | IsPFActionActive (INode *actionNode) |
| An action may be turned ON, OFF, True and
False in Particle
View. |
|
Detailed Description
Action-generic interface IPFAction.
This is a part of every PF Operator & Test.
Definition in file IPFAction.h.
Define Documentation
| #define PFACTION_INTERFACE Interface_ID(0x74f93d00, 0x1eb34500) |
Definition at line 25 of file IPFAction.h.
| #define GetPFActionInterface | ( | obj | ) | ((IPFAction*)((GetPFObject(obj))->GetInterface(PFACTION_INTERFACE))) |
Definition at line 26 of file IPFAction.h.
| #define PROPID_FINALUPDATETIME 0x00635690 |
Definition at line 33 of file IPFAction.h.
Enumeration Type Documentation
| anonymous enum |
- Enumerator:
-
kPF_GetActionDescription kPF_GetActionName kPF_PViewPublic kPF_PViewCategory kPF_IsFertile kPF_IsNonExecutable kPF_PViewDepotIcon
Definition at line 255 of file IPFAction.h.
{ kPF_GetActionDescription = 781,
// defines an action name to be shown in the action depot area in PView
// if the method is not supported then the class name of the action is used
kPF_GetActionName,
// defines if the action is shown in ParticleView Action Depot window
// if the execute is not implemented then it is assumed that the action is
// public
kPF_PViewPublic,
// defines a category for the action to be placed in the Action Depot
// the call is reserved for future use. If the execute is not implemented
// then the category is assigned according to the action type (operator or test)
kPF_PViewCategory,
// defines if the action is "fertile". It means it is able to generate particles
// from nothing. If the execute is not implemented then it is assumed
// that the action is not "fertile".
kPF_IsFertile,
// defines if the action is "non-executable". Non-executable action doesn't
// affect particle behavior. The action is present in the action schematics
// but its presence doesn't change how the particles are shown or rendered.
// If the execute is not implemented then it is assumed that the action is
// executable.
kPF_IsNonExecutable,
// returns bitmap with icon for the depot window of ParticleView
// if the execute is not implemented then a default icon is used
kPF_PViewDepotIcon
};
Function Documentation
Definition at line 285 of file IPFAction.h.
{
return ((obj == NULL) ? NULL : GetPFActionInterface(obj));
};
Definition at line 292 of file IPFAction.h.
{
return ((node == NULL) ? NULL : PFActionInterface(node->GetObjectRef()));
};
| PFExport int IsPFActionActive | ( | INode * | actionNode | ) |
An action may be turned ON, OFF, True and False in Particle View.
An operator has two states: ON (1) and OFF (0). A test has three states: ON (1), False (0) and True (-1). The method returns the state of the action.
Definition at line 294 of file IPFAction.h.
