INodeBakeProperties Class Reference

#include <INodeBakeProperties.h>

Class Description

Description:

This class defines an interface for accessing a node's texture baking properties. An instance of this interface can be retrieved using the following line of code (assuming 'node' is of type INode*):

static_cast<INodeBakeProperties*>(pNode->GetInterface(NODE_BAKE_PROPERTIES_INTERFACE))

Description of the node's texture baking properties:

General Properties:

Enable:

• Texture baking is enabled for this object

Baking Channel:

• Flattening & baking use this uv mapping channel for this object

List of Baking Render Elements:

• each object has a list of render elements for output

Inheritance diagram for INodeBakeProperties:

Public Member Functions
virtual BOOL	GetBakeEnabled () const =0
virtual void	SetBakeEnabled (BOOL isExcluded)=0
virtual int	GetBakeMapChannel () const =0
virtual void	SetBakeMapChannel (int mapChannel)=0
virtual int	GetNDilations () const =0
virtual void	SetNDilations (int nDilations)=0
virtual int	GetBakeFlags () const =0
virtual void	SetBakeFlags (int flags)=0
virtual float	GetSurfaceArea () const =0
virtual void	SetSurfaceArea (float area)=0
virtual float	GetAreaScale () const =0
virtual void	SetAreaScale (float scale)=0
virtual int	GetNBakeElements () const =0
virtual MaxBakeElement *	GetBakeElement (int nElement)=0
virtual Tab< MaxBakeElement * >	GetBakeElementArray ()=0
	returns a Tab object holding the list of Texture Bake elements assigned to the node. More...
virtual BOOL	AddBakeElement (MaxBakeElement *pEle)=0
virtual BOOL	RemoveBakeElement (MaxBakeElement *pEle)=0
virtual BOOL	RemoveBakeElementByName (const MCHAR *name)=0
virtual BOOL	RemoveBakeElementByIndex (int index)=0
virtual void	RemoveAllBakeElements ()=0
virtual void	ResetBakeProps ()=0
virtual BOOL	GetEffectiveEnable ()=0
virtual IPoint2	GetRenderSize ()=0
virtual FBox2	GetActiveRegion ()=0
virtual void	SetActiveRegion (FBox2 region)=0
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 FPInterfaceDesc *	GetDesc ()=0
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...

Additional Inherited Members
Public Types inherited from BaseInterface
enum	LifetimeType { noRelease, immediateRelease, wantsRelease, serverControlled }
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 inherited from FPInterface
static CoreExport FPInterfaceDesc	nullInterface
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)
Protected Attributes inherited from FPMixinInterface
Tab< InterfaceNotifyCallback * > *	interfaceNotifyCBs

Member Function Documentation

virtual BOOL GetBakeEnabled ( ) const

pure virtual

virtual void SetBakeEnabled ( BOOL  isExcluded )

pure virtual

virtual int GetBakeMapChannel ( ) const

pure virtual

virtual void SetBakeMapChannel ( int  mapChannel )

pure virtual

virtual int GetNDilations ( ) const

pure virtual

virtual void SetNDilations ( int  nDilations )

pure virtual

virtual int GetBakeFlags ( ) const

pure virtual

virtual void SetBakeFlags ( int  flags )

pure virtual

virtual float GetSurfaceArea ( ) const

pure virtual

virtual void SetSurfaceArea ( float  area )

pure virtual

virtual float GetAreaScale ( ) const

pure virtual

virtual void SetAreaScale ( float  scale )

pure virtual

virtual int GetNBakeElements ( ) const

pure virtual

virtual MaxBakeElement* GetBakeElement ( int  nElement )

pure virtual

virtual Tab<MaxBakeElement*> GetBakeElementArray ( )

pure virtual

returns a Tab object holding the list of Texture Bake elements assigned to the node.

Developers should not try to set BakeElements by altering the contents of this Tab; use the methods AddBakeElement() and RemoveBakeElement() instead

Returns

a Tab object holding the list of Texture Bake elements assigned to the node.

virtual BOOL AddBakeElement ( MaxBakeElement *  pEle )

pure virtual

virtual BOOL RemoveBakeElement ( MaxBakeElement *  pEle )

pure virtual

virtual BOOL RemoveBakeElementByName ( const MCHAR *  name )

pure virtual

virtual BOOL RemoveBakeElementByIndex ( int  index )

pure virtual

virtual void RemoveAllBakeElements ( )

pure virtual

virtual void ResetBakeProps ( )

pure virtual

virtual BOOL GetEffectiveEnable ( )

pure virtual

virtual IPoint2 GetRenderSize ( )

pure virtual

virtual FBox2 GetActiveRegion ( )

pure virtual

virtual void SetActiveRegion ( FBox2  region )

pure virtual