IProjectionModData Class Reference

IProjectionModData Class Referenceabstract

#include <IProjectionMod.h>

Class Description

See also
Class IProjectionMod
Description:
provides an interface to the Projection Mod Data.
+ Inheritance diagram for IProjectionModData:

Public Member Functions

virtual Interface_ID GetID ()
 
virtual ObjectWrapperGetBaseObject ()=0
 Get ObjectWrapper for the Base Object. More...
 
virtual ObjectWrapperGetCage ()=0
 Get ObjectWrapper for the Cage. More...
 
virtual bool GetObjectSel (int iIndex, BitArray &sel)=0
 Get the object selection by Object Index. More...
 
virtual int GetObjectSelMtlIDs (int iIndex, Tab< int > &mtlIDs)=0
 Get the material IDs by Object Index. More...
 
virtual bool GetGeomSel (int iSelIndex, BitArray &sel)=0
 Get the object selection by Geometry Selection. More...
 
virtual int GetGeomSelMtlIDs (int iSelIndex, Tab< int > &mtlIDs)=0
 Get the material IDs by Geometry Selection. More...
 
virtual float GetGeomSelFaceArea (int iSelIndex)=0
 Get the surface area of selection by Geometry Selection. More...
 
virtual int CheckDuplicateMatIDs (BitArray &bitFaceDups)=0
 Check for duplicate Material IDs Duplicate material IDs can create unwanted results with certain Project Mapping settings in RTT. More...
 
virtual int CheckDuplicateSels (BitArray &bitFaceDups)=0
 Check for duplicate face selection Duplicate face selections can create unwanted results with certain Project Mapping settings in RTT. More...
 
- Public Member Functions inherited from BaseInterface
virtual UtilExport ~BaseInterface ()
 Destructor. More...
 
UtilExport BaseInterfaceGetInterface (Interface_ID id)
 
virtual LifetimeType LifetimeControl ()
 
virtual bool RegisterNotifyCallback (InterfaceNotifyCallback *incb)
 
virtual void UnRegisterNotifyCallback (InterfaceNotifyCallback *incb)
 
virtual BaseInterfaceAcquireInterface ()
 
virtual void ReleaseInterface ()
 
virtual void DeleteInterface ()
 
virtual BaseInterfaceCloneInterface (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 voidoperator new (size_t size)
 Standard new operator used to allocate objects If there is insufficient memory, an exception will be thrown. More...
 
static UtilExport voidoperator 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 voidoperator 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 voidoperator 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 voidoperator 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 voidoperator 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 voidoperator 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 voidoperator 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 voidoperator 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 voidoperator 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 voidoperator new[] (size_t size, int block_type, const char *filename, int line)
 New operator used to allocate arrays of objects. More...
 
static UtilExport voidoperator 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 voidoperator 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 voidoperator 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 voidoperator 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...
 

Member Function Documentation

virtual Interface_ID GetID ( )
inlinevirtual
Remarks
This method returns the unique interface ID.

Reimplemented from BaseInterface.

#define IPROJECTIONMODDATA_INTERFACE_ID
Definition: IProjectionMod.h:27
virtual ObjectWrapper& GetBaseObject ( )
pure virtual

Get ObjectWrapper for the Base Object.

The base object refers to the object that contains the Projection Modifier

Returns
ObjectWrapper reference to ObjectWrapper
virtual ObjectWrapper& GetCage ( )
pure virtual

Get ObjectWrapper for the Cage.

Returns
ObjectWrapper reference to ObjectWrapper
virtual bool GetObjectSel ( int  iIndex,
BitArray sel 
)
pure virtual

Get the object selection by Object Index.

Parameters
[in]iIndexzero based index into number of objects
[out]sel- bitarray of face selection
Returns
bool true if valid bitarray was returned
virtual int GetObjectSelMtlIDs ( int  iIndex,
Tab< int > &  mtlIDs 
)
pure virtual

Get the material IDs by Object Index.

Parameters
[in]iIndexzero based index into number of objects
[out]mtlIDs- Tab< int> of material IDs in selection
Returns
int number of material IDs found
virtual bool GetGeomSel ( int  iSelIndex,
BitArray sel 
)
pure virtual

Get the object selection by Geometry Selection.

Parameters
[in]iSelIndexzero based index into number of geometry selections.
[out]sel- bitarray of face selection
Returns
bool true if valid bitarray was returned
virtual int GetGeomSelMtlIDs ( int  iSelIndex,
Tab< int > &  mtlIDs 
)
pure virtual

Get the material IDs by Geometry Selection.

Parameters
[in]iSelIndexzero based index into number of geometry selections
[out]mtlIDs- Tab< int> of material IDs in selection
Returns
int number of material IDs found
virtual float GetGeomSelFaceArea ( int  iSelIndex)
pure virtual

Get the surface area of selection by Geometry Selection.

Parameters
[in]iSelIndexzero based index into number of geometry selections.
Returns
float surface area of face selection
virtual int CheckDuplicateMatIDs ( BitArray bitFaceDups)
pure virtual

Check for duplicate Material IDs Duplicate material IDs can create unwanted results with certain Project Mapping settings in RTT.

Parameters
[out]bitFaceDups- bitarray of face duplicates
Returns
int Number of faces with duplicates
virtual int CheckDuplicateSels ( BitArray bitFaceDups)
pure virtual

Check for duplicate face selection Duplicate face selections can create unwanted results with certain Project Mapping settings in RTT.

Parameters
[out]bitFaceDups- bitarray of face duplicates
Returns
int Number of faces with duplicates