IGeometryChecker Class Reference

Base Class For Geometry Checkers. More...

#include <IGeometryChecker.h>

Inheritance diagram for IGeometryChecker:

Classes
struct	OutputVal
	The returned output of the checker. More...

Public Types
enum	ReturnVal { eFail = 0x0 , eVertices = 0x1 , eEdges = 0x2 , eFaces = 0x3 }
	Enums of return types that the geometry checker may return. More...
Public Types inherited from BaseInterface
enum	LifetimeType { noRelease , immediateRelease , wantsRelease , serverControlled }

Public Member Functions
virtual	~IGeometryChecker ()
	Virtual Deconstructor. More...
virtual bool	IsSupported (INode *node)=0
	Returns whether or not a given node is valid for this geometry checker. More...
virtual ReturnVal	TypeReturned ()=0
	The type that the geometry checker returns. More...
virtual ReturnVal	GeometryCheck (TimeValue t, INode *node, OutputVal &val)=0
	Perform the geometry check. More...
virtual MSTR	GetName ()=0
	Return the name of the geometry checker. Note that geometry checker name's must be unique. More...
virtual DWORD	GetCheckerID ()=0
	Returns the unique identifier of the geometry checker. More...
virtual bool	HasPropertyDlg ()=0
	Returns true if the geometry checker has a property dialog, false otherwise. More...
virtual void	ShowPropertyDlg ()=0
	Show the property dialog. More...
Override Functions
Returns true if the geometry checker overrides the normal text output, which is usually the number of indices found by the check, plus the geometric type, e.g. '5 Vertices'
virtual bool	HasTextOverride ()=0
	Returns the string that should be displayed in the viewport, rather than the default text output. More...
virtual MSTR	TextOverride ()=0
	Returns the string that should be displayed in the viewport, rather than the default text output. More...
virtual bool	HasDisplayOverride ()=0
	Returns true if the geometry checker overrides the normal display otuput, which is usually highlighted vertices, edges, or faces. More...
virtual void	DisplayOverride (TimeValue t, INode *node, HWND hwnd, Tab< int > &results)=0
	\ brief The display override function used to draw a different display output. More...
Public Member Functions inherited from BaseInterface
virtual UtilExport	~BaseInterface ()
	Destructor. More...
UtilExport BaseInterface *	GetInterface (Interface_ID id) override
virtual UtilExport Interface_ID	GetID ()
virtual LifetimeType	LifetimeControl ()
virtual bool	RegisterNotifyCallback (InterfaceNotifyCallback *incb)
virtual void	UnRegisterNotifyCallback (InterfaceNotifyCallback *incb)
virtual BaseInterface *	AcquireInterface ()
virtual void	ReleaseInterface ()
virtual void	DeleteInterface ()
virtual BaseInterface *	CloneInterface (void *remapDir=nullptr)
Public Member Functions inherited from InterfaceServer
virtual UtilExport	~InterfaceServer ()
	Destructor. More...
template<class InterfaceType >
InterfaceType *	GetTypedInterface ()

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

Detailed Description

Base Class For Geometry Checkers.

The IGeometryChecker class is an abstract base class to be used to create Geometry Checkers GeometryCheckers are basically objects that perform analysis on some INode which then returns the results as a set of geometric indices.

See also

IGeometryCheckerManager

Member Enumeration Documentation

ReturnVal

enum ReturnVal

Enums of return types that the geometry checker may return.

eFail means the check has failed for some reason, the other return types specify what type of geometric entity is returned.

Enumerator
eFail
eVertices
eEdges
eFaces

{eFail = 0x0, eVertices = 0x1, eEdges = 0x2, eFaces = 0x3};

Constructor & Destructor Documentation

~IGeometryChecker()

virtual ~IGeometryChecker ( )

inlinevirtual

Virtual Deconstructor.

{};

Member Function Documentation

IsSupported()

virtual bool IsSupported ( INode *  node )

pure virtual

Returns whether or not a given node is valid for this geometry checker.

Parameters

[in]

node

The node that we will test to see if it is supported.

Returns

Return true if the node is valid, otherwise return false if it is not supported.

TypeReturned()

virtual ReturnVal TypeReturned ( )

pure virtual

The type that the geometry checker returns.

For now we support vertices, edges and polys or tris.

Returns

Returns the type of geometric entity that the checker will output. May be IGeometryChecker::eVertices, IGeometryChecker::eEdges, or IGeometryChecker::eFaces

GeometryCheck()

virtual ReturnVal GeometryCheck ( TimeValue  t, INode *  node, OutputVal &  val  )

pure virtual

Perform the geometry check.

Parameters

[in]	t	The time to run the check
[in]	node	The node to run the check on
[out]	val	The output from the check.

Returns

The ReturnVal of the check. If the check fails for some reason the returned value will be IGeometryChecker::eFail otherwise it will be one of the geometric types.

GetName()

virtual MSTR GetName ( )

pure virtual

Return the name of the geometry checker. Note that geometry checker name's must be unique.

GetCheckerID()

virtual DWORD GetCheckerID ( )

pure virtual

Returns the unique identifier of the geometry checker.

HasPropertyDlg()

virtual bool HasPropertyDlg ( )

pure virtual

Returns true if the geometry checker has a property dialog, false otherwise.

ShowPropertyDlg()

virtual void ShowPropertyDlg ( )

pure virtual

Show the property dialog.

HasTextOverride()

virtual bool HasTextOverride ( )

pure virtual

Returns the string that should be displayed in the viewport, rather than the default text output.

TextOverride()

virtual MSTR TextOverride ( )

pure virtual

Returns the string that should be displayed in the viewport, rather than the default text output.

HasDisplayOverride()

virtual bool HasDisplayOverride ( )

pure virtual

Returns true if the geometry checker overrides the normal display otuput, which is usually highlighted vertices, edges, or faces.

DisplayOverride()

virtual void DisplayOverride ( TimeValue  t, INode *  node, HWND  hwnd, Tab< int > &  results  )

pure virtual

\ brief The display override function used to draw a different display output.

\ param[in] t The time at which to draw the display \ param[in] node The node that was geometry checked \ param[in] hwnd The window handle of the viewport where the display should get outputted. Usually the active viewport. \ param[in] results The last set of results returned by this checker. This may be helpful when drawing the display override.