IPViewItem.h

Module description

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. More...
virtual bool	HasTransparentPViewIcons () const
	Defines whether the custom icons in Particle View have alpha channels. More...
virtual HBITMAP	GetActivePViewIcon ()
	Implement if you want your operator/test to be shown with a custom icon in ParticleView. More...
virtual HBITMAP	GetInactivePViewIcon ()
	Implement if you want your operator/test to be shown with a custom icon in ParticleView. More...
virtual HBITMAP	GetTruePViewIcon ()
	Implement if you want your operator/test to be shown with a custom icon in ParticleView. More...
virtual HBITMAP	GetFalsePViewIcon ()
	Implement if you want your operator/test to be shown with a custom icon in ParticleView. More...
virtual bool	ShowColorSwatch () const
	An operator may have a color swatch UI (color circle on the right side) if it can be used to display particles in viewport. More...
PFExport int	GetNumInstances () const
	Used to track instanced actions. More...
PFExport void	SetNumInstances (int num)
	Used to track instanced actions. More...
PFExport void	IncNumInstances ()
	Used to track instanced actions. More...
PFExport bool	HasComments (INode *itemNode) const
	A PView item can have comments. More...
PFExport const MCHAR *	GetComments (INode *itemNode) const
	See HasComments(). More...
PFExport void	SetComments (INode *itemNode, const MCHAR *comments)
	See HasComments(). More...
PFExport void	EditComments (INode *itemNode, HWND parentWnd, long x, long y)
	See HasComments(). More...
PFExport LRESULT CALLBACK	commentsProc (HWND hwnd, UINT message, WPARAM wParam, LPARAM lParam)
	For internal use. More...
virtual bool	HasDynamicName (MSTR &nameSuffix)
	For dynamic names support; if the action has a dynamic name then it supplies the name suffix. More...
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. More...
static PFExport void	SetWireExtension (INode *node, int wireLen, int wireHight)
	Sets wire length. More...
FPInterfaceDesc *	GetDesc ()

Function Documentation

IPViewItem ( )

inline

{ m_numInstances = 1; }

int NumPViewParamBlocks ( ) const

pure virtual

Implemented in PFSimpleAction.

IParamBlock2 * GetPViewParamBlock ( int  i ) const

pure virtual

Implemented in PFSimpleAction.

PFExport int NumPViewParamMaps

(

)

const

PFExport IParamMap2 * GetPViewParamMap

(

int

i

)

const

PFExport void AddPViewParamMap

(

IParamMap2 *

map

)

PFExport void RemovePViewParamMap

(

IParamMap2 *

map

)

bool HasCustomPViewIcons ( )

inlinevirtual

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

{ return false; }

bool HasTransparentPViewIcons ( ) const

inlinevirtual

Defines whether the custom icons in Particle View have alpha channels.

It is not possible for any specific PFlow action/operator/test to have some icons with alpha, and some without. If the method returns true, then the PFlow action/operator/test has to implement all PViewIcon related methods below and return a 32-bit HBITMAP with alpha channel.

{ return false; }

HBITMAP GetActivePViewIcon ( )

inlinevirtual

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 ( )

inlinevirtual

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 ( )

inlinevirtual

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 ( )

inlinevirtual

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; } 

bool ShowColorSwatch ( ) const

inlinevirtual

An operator may have a color swatch UI (color circle on the right side) if it can be used to display particles in viewport.

The method is used for the case when the color swatch is variable: visibility of the swatch depends on the parameters of the operator. The typical case is 'mP Shape' operator where the particle collision shape is used for debugging purposes only. The operators Display, Display Script, Display Data don't implement this method since they always show their color swatch.

{ return false; }

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

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.

bool HasDynamicName ( MSTR &  nameSuffix )

inlinevirtual

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

Sets wire length.

See GetWireExtension().

FPInterfaceDesc * GetDesc ( )

inlinevirtual

Remarks

Returns a pointer to the class which contains the interface metadata.

Implements FPInterface.

{ return GetDescByID(PVIEWITEM_INTERFACE); }