IPFAction.h File Reference

#include "PFExport.h"
#include "ParticleChannelMask.h"
#include "../ifnpub.h"
#include "../object.h"

File Description

Action-generic interface IPFAction.

This is a part of every PF Operator & Test.

Classes
class	IPFAction

Macros
#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. More...
PFExport bool	IsUndefinedPFAction (INode *actionNode)
	A scene can be saved with third-party PFlow operators / tests that are currently unavailable. More...

Macro Definition Documentation

#define PFACTION_INTERFACE   Interface_ID(0x74f93d00, 0x1eb34500)

#define GetPFActionInterface

(

obj

)

((IPFAction*)((GetPFObject(obj))->GetInterface(PFACTION_INTERFACE)))

#define PROPID_FINALUPDATETIME   0x00635690

Enumeration Type Documentation

anonymous enum

Enumerator
kPF_GetActionDescription
kPF_GetActionName
kPF_PViewPublic
kPF_PViewCategory
kPF_IsFertile
kPF_IsNonExecutable
kPF_PViewDepotIcon

     {  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

PFExport Object* GetPFObject

(

Object *

obj

)

IPFAction * PFActionInterface ( Object *  obj )

inline

                                                 {
    return ((obj == NULL) ? NULL : GetPFActionInterface(obj));
};

IPFAction * PFActionInterface ( INode *  node )

inline

                                                 {
    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.

PFExport bool IsUndefinedPFAction

(

INode *

actionNode

)

A scene can be saved with third-party PFlow operators / tests that are currently unavailable.

In such situation a PFlow operator is shown with "Undefined" icon (question mark) and it does not affect PFlow calculations. The operator / test stub is kept with the scene. A user can delete it but it cannot be copied or moved to different PFlow events.