#include <mesh.h>

Class Description

The SpatialGrid class is an interface for dividing the space of a mesh to grids/cells/voxels.

The space of a mesh is given by a bounding box.

A grid is a alis aligned small space. Grids are given indices by Coord in x/y/z.

Definition at line 1322 of file mesh.h.

Inheritance diagram for SpatialGrid:

Classes
struct	Coord

class	VoxelIterator

Public Member Functions
virtual void	initialize (mudbox::Mesh *mesh, const AxisAlignedBoundingBox &bounds, const Coord &gridDimensions)
	specifies region of space to be gridded, and number of grid cells along each dimension. More...

virtual AxisAlignedBoundingBox	gridBounds () const
	Returns the bounding box for the entire grid. More...

virtual void	voxelRange (const AxisAlignedBoundingBox &cBox, Coord &cMinCoords, Coord &cMaxCoords) const
	Given a bounding box, compute the min and max voxel indices (in x, y, z) of the cells that intersect the box. More...

virtual VoxelIterator	voxelIterator (const Coord &cCoord)
	Returns the iterator for the given coord. More...

virtual void	setDirty (const AxisAlignedBoundingBox &cBox)
	Mark some grids cells dirty, the grids is computed by the given bounding box. More...

virtual void	update ()
	Update the grids cells according to the dirty flags. More...

virtual void	extend ()
	Extend the extire grid based on the target mesh's new bounding box. More...

virtual bool	closestPoint (mudbox::SurfacePoint &surfacePt, mudbox::Mesh *pMesh, const mudbox::Vector &vPoint, const mudbox::Vector &vDirection, bool bothDirections=false)
	To find the closest surface point given specified position and direction. More...

Public Member Functions inherited from TreeNode
	TreeNode (void)

	~TreeNode (void)

virtual void	Serialize (Stream &s)
	Serializes the node. More...

virtual void	AddChild (TreeNode *pChild, bool bFirst=false) const
	Adds a node/subtree to the list of children. The added node will be removed from the current parent if it has one. More...

virtual void	RemoveChild (TreeNode *pChild) const
	Removes a node/subtree from the list of children. More...

virtual TreeNode *	FirstChild (void) const
	Returns the first node from the child list. More...

virtual TreeNode *	Parent (void) const
	Returns the parent node. More...

virtual TreeNode *	NextSibling (void) const
	Returns the next linked node with the same parent. More...

virtual TreeNode *	PrevSibling (void) const
	Returns the previous linked node with the same parent. More...

virtual void	MoveChild (TreeNode pChild, TreeNode pAfter)
	Moves the child after the given node in order. More...

virtual TreeNode *	ChildByClass (const ClassDesc *pClass, bool bAutoCreate=true) const
	Returns the first child with the specified type. When the bAutoCreate parameter is true and such a child does not exists, it creates it with the preferred descedant type. More...

template<typename type >
type *	ChildByClass (bool bAutoCreate=true) const
	Same as above, a most confortable version. More...

virtual TreeNode *	ChildByClass (const ClassDesc *pClass, unsigned int iIndex=0) const
	Returns the first child with the specified type, or returns zero if no child found. More...

template<typename type >
type *	ChildByClass (unsigned int iIndex=0) const
	Same as above, a most confortable version. More...

virtual void	DeleteChildByClass (const ClassDesc *pClass)
	Deletes all child which is derived from a specific class. More...

virtual QString	Info (void) const
	Returns descriptive information about the node. More...

virtual bool	Visible (void) const
	Returns if the node is visible. Should be overridden in derived classes. More...

virtual void	SetVisible (bool b)
	Sets the node visibility Should be overridden in derived classes. More...

virtual bool	Locked (void) const
	Returns if the node is locked. Should be overridden in derived classes. More...

virtual void	SetLocked (bool b)
	Sets the locking of the node. Should be overridden in derived classes. More...

virtual bool	HiddenFromUI (void) const
	Returns true if the node cannot be seen from UI. More...

virtual void	SetHiddenFromUI (bool b)
	Sets visibility in UI. More...

virtual void	OnLinked (const TreeNode *pOldParent)
	This function is called then the node is linked to a new parent. More...

virtual void	CheckValidity (Node::DiagnosticLevel iLevel=dgnLevel2) const
	See the documentation for Node::CheckValidity. More...

QString	UniqueChildName (const TreeNode *pChild, const QString &sPrefix="") const
	Finds a node name that is unique among the children of this node. More...

virtual void	SetStringID (const QString &sName)
	This method does the same thing as Node::SetStringID, except it ensures the name is unique among this node's siblings. More...

virtual void	CopyTo (Node *pNode) const

Public Member Functions inherited from Node
	Node (const QString &sStringID="", const QString &sDisplayName="")
	Standard constructor. More...

virtual	~Node (void)

virtual void	Initialize (void)

void	LoadTemplate (const QString &sFileName="", bool bStartEvent=false)
	Use an external XML file to initialize the attributes. More...

void	SaveTemplate (const QString &sFileName="", bool bSaveOnlyVisible=false)
	Save current attributes as an XML template. More...

unsigned int	Version (void) const
	Returns the current version of the node. This number increases when the content of the node changed (when ContentChanged() called). More...

void	SetVersion (unsigned int iVersion)
	Sets the current version number for the node. More...

unsigned int	ReferenceCount (void) const
	Returns the number of pointers referencing this node. More...

Attribute *	ReferencePointer (unsigned int iIndex) const
	Returns the address of an attribute which refers to this node. The type of the attribute is always aptr. More...

Node *	ReferenceNode (unsigned int iIndex) const
	Returns the address of a node referencing this node. More...

virtual QString	Name (const ClassDesc *pClass=0) const
	Deprecated. More...

virtual void	SetName (const QString &sName)
	Deprecated. More...

virtual QString	StringID (const ClassDesc *pClass=0) const
	Returns the string id of the node. More...

virtual QString	DisplayName (void) const
	Returns the display name of the node. More...

virtual void	SetDisplayName (const QString &sDisplayName)
	Sets the display name of the node. More...

virtual QString	HelpID (void) const
	Returns the help entry id of the node. Can be overwritten in derived classes. More...

virtual void	SetHelpID (const QString &sHelpID)
	Sets the help entry id of the node. More...

void	Annex (Node *pSource, const QString &sCategory="")
	Relink all the attributes of the source node to this one. More...

bool	IsKindOf (const ClassDesc *pClass) const
	Returns true if this node is derived from the pClass class. More...

void	ContentChanged (void) const
	This function must be called if the content of the node is changed. More...

virtual Node *	Duplicate (void) const

virtual void	OnNodeEvent (const Attribute &cAttribute, NodeEventType cType)
	This function is called if an event occurs with any of the attributes of the node. More...

virtual void	OnEvent (const EventGate &cEvent)
	This function is called when a generic event occurs. See EventGate class. More...

void	RequestDeferredEvent (Attribute &cAttribute)
	Request for a deferred event, which will occur only in the main loop. More...

unsigned int	AttributeCount (void) const
	Returns the number of attributes owned by the node. More...

Attribute *	AttributeByIndex (int iIndex) const
	Returns a specified attribute (or 0 if iIndex is greater than the number of attributes). More...

Attribute *	AttributeByName (const QString &sName) const
	Returns a specified attribute by its name. Returns 0 if the attribute not found. More...

Attribute *	AttributeByID (const QString &sID) const
	Returns a specified attribute by its ID. Returns 0 if the attribute not found. More...

void	SetAttributeValue (const QString &sAttributeID, const QString &sNewValue)
	Set the value of an attribute from a string. More...

QString	AttributeValue (const QString &sAttributeID) const
	Returns the current value of an attribute as a string. More...

void	LogAttributes (void) const
	Write all attributes into the log file. More...

virtual QWidget *	CreatePropertiesWindow (QWidget *pParent)
	Create a window which displays the attributes of the node. Can be overriden to provide a custom interface. More...

Attribute *	AddAttribute (Attribute::AttributeType type, const QString &id)
	Allows SDK users to add attributes at runtime. More...

Node *	Next (void) const
	Returns the next node in the chain. Used to enumerate the current nodes. See also First(). More...

int	ID (void) const
	Returns an ID for the node. The ID is unique in the whole application life. More...

bool	SetID (int iID)
	Set ID for the node. More...

Static Public Member Functions
static Coord	computeDimensions (const mudbox::Mesh *mesh, unsigned int facesPerVoxel, const Coord &minVoxels, const Coord &maxVoxels)
	Comes up with an estimate of the number of grid cells in x, y, and z necessary to subdivide the given poly in order that each grid cell contain roughly "facesPerVoxel" faces. More...

Static Public Member Functions inherited from Node
static void	StartHashing ()
	This is called once in main once static ctors are done. More...

static Node *	First (void)
	This function will return the first node in the memory. Used to enumerate all the current nodes. See also Next(). More...

static Node *	ByID (int iID)
	Returns the node with the specified ID, or zero if such a node does not exists. More...

static Node *	ByName (const QString &sClass, const QString &sName)
	Search for a node with the name sName. More...

Additional Inherited Members
Public Types inherited from Node
enum	DiagnosticLevel { dgnLevel1, dgnLevel2, dgnLevel3 }
	Indicates the level of validity checking that is performed in CheckValidity() More...

Public Attributes inherited from TreeNode
	DECLARE_CLASS

Public Attributes inherited from Node
AttributeThisPointer	m_pThis

	DECLARE_CLASS

Member Function Documentation

static Coord computeDimensions	(	const mudbox::Mesh *	mesh,
		unsigned int	facesPerVoxel,
		const Coord &	minVoxels,
		const Coord &	maxVoxels
	)

static

Comes up with an estimate of the number of grid cells in x, y, and z necessary to subdivide the given poly in order that each grid cell contain roughly "facesPerVoxel" faces.

The number of voxel subdivisions returned will be clamped to the specified minVoxels and maxVoxels value. [in] the maximum cell dimension along xyz.

Parameters

[in]	mesh	the target object.
[in]	facesPerVoxel	the roughly face number in a grid cell.
[in]	minVoxels	the minimum cell dimension along xyz.

virtual void initialize	(	mudbox::Mesh *	mesh,
		const AxisAlignedBoundingBox &	bounds,
		const Coord &	gridDimensions
	)

virtual

specifies region of space to be gridded, and number of grid cells along each dimension.

[in] the specified dimension, can use the result of computeDimensions().

Parameters

[in]	mesh	the target object.
[in]	bounds	the bounding box containing the target object.

virtual AxisAlignedBoundingBox gridBounds ( ) const

virtual

Returns the bounding box for the entire grid.

virtual void voxelRange	(	const AxisAlignedBoundingBox &	cBox,
		Coord &	cMinCoords,
		Coord &	cMaxCoords
	)		const

virtual

Given a bounding box, compute the min and max voxel indices (in x, y, z) of the cells that intersect the box.

Parameters

[in]	cBox	the given bounding box.
[out]	cMinCoords	the min voxel indices.
[out]	cMaxCoords	the max voxel indices.

virtual VoxelIterator voxelIterator ( const Coord & cCoord )

virtual

Returns the iterator for the given coord.

[in] the given voxel index.

virtual void setDirty ( const AxisAlignedBoundingBox & cBox )

virtual

Mark some grids cells dirty, the grids is computed by the given bounding box.

[in] the given bounding box.

virtual void update ( )

virtual

Update the grids cells according to the dirty flags.

virtual void extend ( )

virtual

Extend the extire grid based on the target mesh's new bounding box.

virtual bool closestPoint	(	mudbox::SurfacePoint &	surfacePt,
		mudbox::Mesh *	pMesh,
		const mudbox::Vector &	vPoint,
		const mudbox::Vector &	vDirection,
		bool	bothDirections = `false`
	)

virtual

To find the closest surface point given specified position and direction.

[in] whether to search in two directions.

Parameters

[out]	surfacePt	the found surface point.
[in]	pMesh	the target mesh.
[in]	vPoint	the position at local space.
[in]	vDirection	the search direction at local space.

The documentation for this class was generated from the following file:

Mudbox/mesh.h

SpatialGrid Class Reference

Class Description

Classes

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Member Function Documentation