IPViewItem.h
 
 
 
IPViewItem.h

Functions

  IPViewItem ()
virtual int  NumPViewParamBlocks () const =0
virtual IParamBlock2 GetPViewParamBlock (int i) const =0
PFExport int  NumPViewParamMaps () const
PFExport IParamMap2 GetPViewParamMap (int i) const
PFExport void  AddPViewParamMap (IParamMap2 *map)
PFExport void  RemovePViewParamMap (IParamMap2 *map)
virtual bool  HasCustomPViewIcons ()
  Implement if you want your operator/test to be shown with a custom icon in ParticleView.
virtual HBITMAP  GetActivePViewIcon ()
  Implement if you want your operator/test to be shown with a custom icon in ParticleView.
virtual HBITMAP  GetInactivePViewIcon ()
  Implement if you want your operator/test to be shown with a custom icon in ParticleView.
virtual HBITMAP  GetTruePViewIcon ()
  Implement if you want your operator/test to be shown with a custom icon in ParticleView.
virtual HBITMAP  GetFalsePViewIcon ()
  Implement if you want your operator/test to be shown with a custom icon in ParticleView.
PFExport int  GetNumInstances () const
  Used to track instanced actions.
PFExport void  SetNumInstances (int num)
  Used to track instanced actions.
PFExport void  IncNumInstances ()
  Used to track instanced actions.
PFExport bool  HasComments (INode *itemNode) const
  A PView item can have comments.
PFExport const MCHAR *  GetComments (INode *itemNode) const
  See HasComments().
PFExport void  SetComments (INode *itemNode, const MCHAR *comments)
  See HasComments().
PFExport void  EditComments (INode *itemNode, HWND parentWnd, long x, long y)
  See HasComments().
PFExport LRESULT CALLBACK  commentsProc (HWND hwnd, UINT message, WPARAM wParam, LPARAM lParam)
  For internal use.
virtual bool  HasDynamicName (MSTR &nameSuffix)
  For dynamic names support; if the action has a dynamic name then it supplies the name suffix.
static PFExport int  GetWireExtension (INode *node, int &wireHeight)
  To read/modify the length/height of the wire nub extended from an emitter, or an action list, or a test.
static PFExport void  SetWireExtension (INode *node, int wireLen, int wireHight)
  Sets wire length.
FPInterfaceDesc GetDesc ()

Function Documentation

int NumPViewParamBlocks ( ) const [pure virtual]
IParamBlock2 * GetPViewParamBlock ( int  i ) const [pure virtual]
PFExport int NumPViewParamMaps ( ) const
PFExport IParamMap2 * GetPViewParamMap ( int  i ) const
PFExport void AddPViewParamMap ( IParamMap2 map )
PFExport void RemovePViewParamMap ( IParamMap2 map )
bool HasCustomPViewIcons ( ) [inline, virtual]

Implement if you want your operator/test to be shown with a custom icon in ParticleView.

{ return false; }
HBITMAP GetActivePViewIcon ( ) [inline, virtual]

Implement if you want your operator/test to be shown with a custom icon in ParticleView.

For operator/test when in active state.

{ return NULL; }  
HBITMAP GetInactivePViewIcon ( ) [inline, virtual]

Implement if you want your operator/test to be shown with a custom icon in ParticleView.

For operator when in disabled state.

{ return NULL; }
HBITMAP GetTruePViewIcon ( ) [inline, virtual]

Implement if you want your operator/test to be shown with a custom icon in ParticleView.

For test when in "always true" state.

{ return NULL; } 
HBITMAP GetFalsePViewIcon ( ) [inline, virtual]

Implement if you want your operator/test to be shown with a custom icon in ParticleView.

For test when in "always false" state.

{ return NULL; } 
PFExport int GetNumInstances ( ) const

Used to track instanced actions.

An action may have several instances, which PView shows in italic font.

PFExport void SetNumInstances ( int  num )

Used to track instanced actions.

An action may have several instances, which PView shows in italic font.

PFExport void IncNumInstances ( )

Used to track instanced actions.

An action may have several instances, which PView shows in italic font.

PFExport bool HasComments ( INode itemNode ) const

A PView item can have comments.

Comments are also shown and edited via right-click above the PView item.

PFExport MSTR GetComments ( INode itemNode ) const
PFExport void SetComments ( INode itemNode,
const MCHAR *  comments 
)
PFExport void EditComments ( INode itemNode,
HWND  parentWnd,
long  x,
long  y 
)
PFExport LRESULT CALLBACK commentsProc ( HWND  hwnd,
UINT  message,
WPARAM  wParam,
LPARAM  lParam 
)

For internal use.

bool HasDynamicName ( MSTR nameSuffix ) [inline, virtual]

For dynamic names support; if the action has a dynamic name then it supplies the name suffix.

{ UNUSED_PARAM(nameSuffix); return false; }
PFExport static int GetWireExtension ( INode node,
int &  wireHeight 
) [static]

To read/modify the length/height of the wire nub extended from an emitter, or an action list, or a test.

You must supply the node of the item. This method returns wire length.

PFExport static void SetWireExtension ( INode node,
int  wireLen,
int  wireHight 
) [static]
FPInterfaceDesc * GetDesc ( ) [inline, virtual]
Remarks:
Returns a pointer to the class which contains the interface metadata.

Implements FPInterface.