IPViewItem Class Reference

#include <IPViewItem.h>

Inheritance diagram for IPViewItem:

Public Types
enum	{   kNumPViewParamBlocks, kGetPViewParamBlock, kHasComments, kGetComments,   kSetComments, kGetWireExtension, kSetWireExtension }
Public Types inherited from BaseInterface
enum	LifetimeType { noRelease, immediateRelease, wantsRelease, serverControlled }

Public Member Functions
	FN_0 (kNumPViewParamBlocks, TYPE_INT, NumPViewParamBlocks)
	FN_1 (kGetPViewParamBlock, TYPE_REFTARG, GetPViewParamBlock, TYPE_INDEX)
	FN_1 (kHasComments, TYPE_bool, HasComments, TYPE_INODE)
	FN_1 (kGetComments, TYPE_STRING, GetComments, TYPE_INODE)
	VFN_2 (kSetComments, SetComments, TYPE_INODE, TYPE_STRING)
	FN_2 (kGetWireExtension, TYPE_INT, GetWireExtension, TYPE_INODE, TYPE_INT)
	VFN_3 (kSetWireExtension, SetWireExtension, TYPE_INODE, TYPE_INT, TYPE_INT)
	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...
FPInterfaceDesc *	GetDesc ()
Public Member Functions inherited from FPMixinInterface
	FPMixinInterface ()
virtual LifetimeType	LifetimeControl ()
virtual CoreExport bool	RegisterNotifyCallback (InterfaceNotifyCallback *incb)
virtual void	UnRegisterNotifyCallback (InterfaceNotifyCallback *incb)
CoreExport	~FPMixinInterface ()
virtual BaseInterface *	GetInterface (Interface_ID id)
virtual FPInterfaceDesc *	GetDescByID (Interface_ID id)
virtual Interface_ID	GetID ()
Public Member Functions inherited from FPInterface
virtual CoreExport FPStatus	Invoke (FunctionID fid, TimeValue t=0, FPParams *params=NULL)
virtual FPStatus	Invoke (FunctionID fid, FPParams *params)
virtual CoreExport FPStatus	Invoke (FunctionID fid, TimeValue t, FPValue &result, FPParams *params=NULL)
virtual FPStatus	Invoke (FunctionID fid, FPValue &result, FPParams *params=NULL)
virtual CoreExport FunctionID	FindFn (const MCHAR *name)
virtual CoreExport BOOL	IsEnabled (FunctionID actionID)
virtual CoreExport BOOL	IsChecked (FunctionID actionID)
virtual CoreExport BOOL	IsVisible (FunctionID actionID)
virtual CoreExport FunctionID	GetIsEnabled (FunctionID actionID)
virtual CoreExport FunctionID	GetIsChecked (FunctionID actionID)
virtual CoreExport FunctionID	GetIsVisible (FunctionID actionID)
virtual ActionTable *	GetActionTable ()
virtual void	EnableActions (BOOL onOff)
Public Member Functions inherited from BaseInterface
virtual UtilExport	~BaseInterface ()
	Destructor. More...
virtual BaseInterface *	AcquireInterface ()
virtual void	ReleaseInterface ()
virtual void	DeleteInterface ()
virtual BaseInterface *	CloneInterface (void *remapDir=NULL)
Public Member Functions inherited from InterfaceServer
virtual UtilExport	~InterfaceServer ()
	Destructor. More...

Static Public Member Functions
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...
Static Public Member Functions inherited from MaxHeapOperators
static UtilExport void *	operator new (size_t size)
	Standard new operator used to allocate objects If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e)
	Standard new operator used to allocate objects if there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new (size_t size, const char *filename, int line)
	New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate objects that takes the type of memory, filename and line number where the new was called If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e, const char *filename, int line)
	New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new (size_t size, unsigned long flags)
	New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e, unsigned long flags)
	New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new[] (size_t size)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new[] (size_t size, const char *filename, int line)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new[] (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate arrays of objects. More...
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e, const char *filename, int line)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new[] (size_t size, unsigned long flags)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e, unsigned long flags)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...
static UtilExport void	operator delete (void *ptr)
	Standard delete operator used to deallocate an object If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e)
	Standard delete operator used to deallocate an object If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete (void *ptr, const char *filename, int line)
	Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete (void *ptr, int block_type, const char *filename, int line)
	Delete operator used to deallocate an object that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e, const char *filename, int line)
	Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete (void *ptr, unsigned long flags)
	Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e, unsigned long flags)
	Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete[] (void *ptr)
	Standard delete operator used to deallocate an array of objects If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e)
	Standard delete operator used to deallocate an array of objects If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete[] (void *ptr, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete[] (void *ptr, int block_type, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete[] (void *ptr, unsigned long flags)
	Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e, unsigned long flags)
	Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, void *placement_ptr)
	Placement new operator. More...
static UtilExport void	operator delete (void *ptr, void *placement_ptr)
	Placement delete operator. More...

Static Public Attributes
static const DWORD	PViewItemCommentsChunk = 0x354b7085
Static Public Attributes inherited from FPInterface
static CoreExport FPInterfaceDesc	nullInterface

Protected Attributes
Tab< IParamMap2 * >	m_paramMaps
int	m_numInstances
Tab< INode * >	m_nodes
Tab< HWND >	m_hWnds
Protected Attributes inherited from FPMixinInterface
Tab< InterfaceNotifyCallback * > *	interfaceNotifyCBs

Additional Inherited Members
Protected Member Functions inherited from FPMixinInterface
	FPMixinInterface (const FPMixinInterface &rhs)
FPMixinInterface &	operator= (const FPMixinInterface &rhs)
Protected Member Functions inherited from FPInterface
virtual FPStatus	_dispatch_fn (FunctionID fid, TimeValue t, FPValue &result, FPParams *p)

Member Enumeration Documentation

anonymous enum

Enumerator
kNumPViewParamBlocks
kGetPViewParamBlock
kHasComments
kGetComments
kSetComments
kGetWireExtension
kSetWireExtension

         {  kNumPViewParamBlocks,
            kGetPViewParamBlock,
            kHasComments,
            kGetComments,
            kSetComments,
            kGetWireExtension,
            kSetWireExtension
    }; 

Member Function Documentation

FN_0	(	kNumPViewParamBlocks	,
		TYPE_INT	,
		NumPViewParamBlocks
	)

FN_1	(	kGetPViewParamBlock	,
		TYPE_REFTARG	,
		GetPViewParamBlock	,
		TYPE_INDEX
	)

FN_1	(	kHasComments	,
		TYPE_bool	,
		HasComments	,
		TYPE_INODE
	)

FN_1	(	kGetComments	,
		TYPE_STRING	,
		GetComments	,
		TYPE_INODE
	)

VFN_2	(	kSetComments	,
		SetComments	,
		TYPE_INODE	,
		TYPE_STRING
	)

FN_2	(	kGetWireExtension	,
		TYPE_INT	,
		GetWireExtension	,
		TYPE_INODE	,
		TYPE_INT
	)

VFN_3	(	kSetWireExtension	,
		SetWireExtension	,
		TYPE_INODE	,
		TYPE_INT	,
		TYPE_INT
	)

Member Data Documentation

const DWORD PViewItemCommentsChunk = 0x354b7085

static

Tab<IParamMap2*> m_paramMaps

protected

int m_numInstances

protected

Tab<INode*> m_nodes

protected

Tab<HWND> m_hWnds

protected