#include <ISimpleFaceDataManager.h>

Class Description

The function-published interface for managing SimpleFaceData channels on an object.

This manager allows simple per-face data channels to be added, removed and retrieved from the specified editable mesh or poly object. This static function-published interface is registered as a core interface. Obtain a pointer to this interface with GetInterface() using its defined ID, SimpleFaceDataManger_InterfaceID. Functions provided by this interface can also be called through function-publish dispatching and through Maxscript.

See also: ISimpleFaceFaceDataChannel

Inheritance diagram for ISimpleFaceDataManager:

Public Types
enum	{ eFpAddChannel, eFpRemoveChannel, eFpGetChannel, eFpGetChannels, eFpChannelTypeEnum }
	Function-publish IDs for the SimpleFaceData Manager functions. More...

Public Types inherited from BaseInterface
enum	LifetimeType { noRelease, immediateRelease, wantsRelease, serverControlled }

Public Member Functions
virtual ISimpleFaceDataChannel *	AddChannel (Object pObj, int type, const Class_ID pChannelID, const MCHAR *pChannelName) const =0
	Add a simple per-face data channel to a geometry object (C++). More...

virtual ISimpleFaceDataChannel *	AddChannel (Object pObj, int type, const Tab< DWORD > pChannelID, const MCHAR *pChannelName) const =0
	Add a simple per-face data channel to the specified geometry object (Maxscript). More...

virtual void	RemoveChannel (Object *pObj, const Class_ID &channelID)=0
	Remove a simple per-face data channel from a geometry object (C++). More...

virtual void	RemoveChannel (Object pObj, const Tab< DWORD > pChannelID)=0
	Remove a simple per-face data channel from a geometry object (Maxscript). More...

virtual ISimpleFaceDataChannel *	GetChannel (Object pObj, const Tab< DWORD > pChannelID) const =0
	Get a simple per-face data channel from a geometry object (C++). More...

virtual ISimpleFaceDataChannel *	GetChannel (Object *pObj, const Class_ID &channelID) const =0
	Get a simple per-face data channel from a geometry object (Maxscript). More...

virtual Tab< ISimpleFaceDataChannel * >	GetChannels (Object *pObj) const =0
	Get all simple per-face data channels from a geometry object (C++, Maxscript). More...

Public Member Functions inherited from FPInterfaceDesc
CoreExport	FPInterfaceDesc ()

CoreExport	FPInterfaceDesc (Interface_ID id, const MCHAR int_name, StringResID descr, ClassDesc cd, ULONG flag,...)

CoreExport	~FPInterfaceDesc ()

virtual void	Init ()

LifetimeType	LifetimeControl ()

virtual BaseInterface *	GetInterface (Interface_ID id)

CoreExport void	LoadDescriptor (Interface_ID id, const MCHAR int_name, StringResID descr, ClassDesc pCD, ULONG flag,...)

CoreExport void	AppendFunction (int id,...)
	Add a new function to this interface descriptor. More...

CoreExport void	AppendProperty (int id,...)
	Add a new property to this interface descriptor. More...

CoreExport void	AppendEnum (int id,...)
	Add a new enum to this interface descriptor. More...

CoreExport void	SetClassDesc (ClassDesc *i_cd)

CoreExport va_list	check_fn (va_list ap, int id)

CoreExport va_list	scan_fn (va_list ap, int id, int index)

CoreExport va_list	check_prop (va_list ap, int id)

CoreExport va_list	scan_prop (va_list ap, int id, int index)

CoreExport va_list	check_enum (va_list ap, EnumID id)

CoreExport va_list	scan_enum (va_list ap, EnumID id, int index)

FPInterfaceDesc *	GetDesc ()

Interface_ID	GetID ()

CoreExport FPFunctionDef *	GetFnDef (FunctionID fid)

ActionTable *	GetActionTable ()

CoreExport void	EnableActions (BOOL onOff)

virtual CoreExport HINSTANCE	HInstance ()

virtual CoreExport const MCHAR *	GetRsrcString (StringResID id)

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)

Public Member Functions inherited from BaseInterface
virtual UtilExport	~BaseInterface ()
	Destructor. More...

virtual bool	RegisterNotifyCallback (InterfaceNotifyCallback *incb)

virtual void	UnRegisterNotifyCallback (InterfaceNotifyCallback *incb)

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

Additional Inherited Members
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 UtilExport void *	aligned_malloc (size_t size, size_t alignment)
	Allocates memory on a specified alignment boundary. More...

static UtilExport void *	aligned_realloc (void *ptr, size_t size, size_t alignment)
	Reallocates memory on a specified alignment boundary. More...

static UtilExport void	aligned_free (void *ptr)
	Frees a block of memory that was allocated with aligned_malloc/aligned_realloc. More...

Public Attributes inherited from FPInterfaceDesc
Interface_ID	ID

MSTR	internal_name

StringResID	description

ClassDesc *	cd

USHORT	flags

Tab< FPFunctionDef * >	functions

Tab< FPPropDef * >	props

Tab< FPEnum * >	enumerations

MSPluginClass *	pc

Rollout *	rollout

ActionTable *	action_table

Static Public Attributes inherited from FPInterface
static CoreExport FPInterfaceDesc	nullInterface

Protected Member Functions inherited from FPInterfaceDesc
CoreExport void	load_descriptor (Interface_ID id, const MCHAR int_name, StringResID descr, ClassDesc cd, USHORT flag, va_list ap)

Protected Member Functions inherited from FPInterface
virtual FPStatus	_dispatch_fn (FunctionID fid, TimeValue t, FPValue &result, FPParams *p)

Member Enumeration Documentation

anonymous enum

Function-publish IDs for the SimpleFaceData Manager functions.

Enumerator
eFpAddChannel
eFpRemoveChannel
eFpGetChannel
eFpGetChannels
eFpChannelTypeEnum

          {
         eFpAddChannel, // Add a channel to this object
         eFpRemoveChannel, // Remove a channel from this object
         eFpGetChannel, // Get a channel on this object
         eFpGetChannels, // Get an array of all channels on this object
 
         eFpChannelTypeEnum, // ID for the function-published channel-type enum.
     };

Member Function Documentation

virtual ISimpleFaceDataChannel* AddChannel	(	Object *	pObj,
		int	type,
		const Class_ID *	pChannelID,
		const MCHAR *	pChannelName
	)		const

pure virtual

Add a simple per-face data channel to a geometry object (C++).

A new per-face data channel of the specified type with an identifying ID and name is added to specified object's base object. Per-face data channels are geometry pipeline clients - adding a channel to an object adds the channel throughout the entire modifier stack.

Parameters

[in]	pObj	- The target geometry object. Must be non-null. Only editable mesh and editable poly objects are currently supported.
[in]	type	- A ParamType or ParamType2 enum value that specifies the data type for all faces within the data channel. The current list of supported types is: TYPE_INT TYPE_INDEX TYPE_BOOL TYPE_FLOAT TYPE_POINT2_BV TYPE_POINT3_BV No channel is added if an unsupported type is specified.
[in]	pChannelID	- The identifying Class_ID of the new channel. Specify NULL to have a unique ID generated and assigned to the new channel. If an ID is specified, no channel is added if a channel with the specified ID already exists.
[in]	pChannelName	- The name of the new channel. Specify NULL to use a default channel name.

Returns: A pointer to the new channel instance if one was added. NULL if no channel was added.

virtual ISimpleFaceDataChannel* AddChannel	(	Object *	pObj,
		int	type,
		const Tab< DWORD > *	pChannelID,
		const MCHAR *	pChannelName
	)		const

pure virtual

Add a simple per-face data channel to the specified geometry object (Maxscript).

The maxscript exposed wrapper for AddChannel(). The only difference is that this channel ID is specified as a 2 element array of DWORDS.

See also: AddChannel (C++)

virtual void RemoveChannel	(	Object *	pObj,
		const Class_ID &	channelID
	)

pure virtual

Remove a simple per-face data channel from a geometry object (C++).

Remove the per-face data channel on the specified object's base object that matches the specified channel ID. The channel is removed throughout the entire modifier stack.

Parameters

[in]	pObj	- The target geometry object. Must be non-null.
[in]	channelID	- The identifying Class_ID of the channel to remove.

virtual void RemoveChannel	(	Object *	pObj,
		const Tab< DWORD > *	pChannelID
	)

pure virtual

Remove a simple per-face data channel from a geometry object (Maxscript).

The maxscript exposed wrapper for RemoveChannel(). The only difference is that the channel ID is specified as a 2 element array of DWORDS.

See also: RemoveChannel (C++)

virtual ISimpleFaceDataChannel* GetChannel	(	Object *	pObj,
		const Tab< DWORD > *	pChannelID
	)		const

pure virtual

Get a simple per-face data channel from a geometry object (C++).

Obtain a pointer to the per-face data channel on the specified object that matches the specified channel ID.

Parameters

[in]	pObj	- The target geometry object. Must be non-null.
[in]	pChannelID	- The identifying Class_ID of the channel to retrieve.

Returns: A pointer to the desired channel instance. NULL if a channel with the specified ID was not found.

virtual ISimpleFaceDataChannel* GetChannel	(	Object *	pObj,
		const Class_ID &	channelID
	)		const

pure virtual

Get a simple per-face data channel from a geometry object (Maxscript).

The maxscript exposed wrapper for GetChannel(). The only difference is that this channel ID is specified as a 2 element array of DWORDS.

See also: GetChannel (C++)

virtual Tab<ISimpleFaceDataChannel*> GetChannels ( Object * pObj ) const

pure virtual

Get all simple per-face data channels from a geometry object (C++, Maxscript).

Obtain an array of pointers to all simple per-face data channels on the specified object.

Parameters

[in] pObj - The target geometry object. Must be non-null.

Returns: An array of pointers to simple per-face data channels. An empty array if no channels were found.

ISimpleFaceDataManager Class Reference

Class Description

Public Types

Public Member Functions

Additional Inherited Members

Member Enumeration Documentation

Member Function Documentation