Implementation of a 3D bounding box. More...

#include <MBoundingBox.h>

Public Member Functions
	MBoundingBox ()
	Default constructor. More...

	MBoundingBox (const MBoundingBox &src)
	Copy constructor. More...

	MBoundingBox (const MPoint &corner1, const MPoint &corner2)
	Constructor that creates a bounding box which contains the given points. More...

	~MBoundingBox ()
	Class destructor.

void	clear ()
	Empties the current bounding box.

void	transformUsing (const MMatrix &matrix)
	Apply the given transformation to this bounding box. More...

void	expand (const MPoint &point)
	Expand the bounding box to include the given point. More...

void	expand (const MBoundingBox &box)
	Expand the bounding box to include a second bounding box. More...

bool	contains (const MPoint &point) const
	Returns true if the bounding box contains the given point. More...

bool	intersects (const MBoundingBox &box, double tol=0.0) const
	Returns true if the bounding box intersects another given bounding box. More...

double	width () const
	Returns the width of the bounding box. More...

double	height () const
	Returns the height of the bounding box. More...

double	depth () const
	Returns the depth of the bounding box. More...

MPoint	center () const
	Returns the center of the bounding box. More...

MPoint	min () const
	Returns the minimum point for the bounding box. More...

MPoint	max () const
	Returns the maximum point for the bounding box. More...

MBoundingBox &	operator= (const MBoundingBox &other)
	Assignment operator. More...

Detailed Description

Implementation of a 3D bounding box.

This class provides an implementation of a bounding box. A bounding box describes a volume in space that bounds a piece of geometry. The box is defined by two points which describe the minimum and maximum corners of the box.

Examples:: AbcBullet/AbcWriteJob.cpp, AbcExport/AbcWriteJob.cpp, AbcExport/AbcWriteJob.h, apiDirectionalLightShape/apiDirectionalLightShape.cpp, apiDirectionalLightShape/apiDirectionalLightShape.h, apiMeshShape/apiMeshShape.cpp, apiMeshShape/apiMeshShape.h, apiMeshShape/apiMeshShapeUI.cpp, apiMeshShape/apiMeshSubSceneOverride.cpp, footPrintManip/footPrintManip.cpp, footPrintNode/footPrintNode.cpp, footPrintNode_AnimatedMaterial/footPrintNode_GeometryOverride_AnimatedMaterial.cpp, footPrintNode_GeometryOverride/footPrintNode_GeometryOverride.cpp, footPrintNode_SubSceneOverride/footPrintNode_SubSceneOverride.cpp, geometryOverrideExample1/geometryOverrideExample1.cpp, geometryOverrideExample1/geometryOverrideExample1.h, geometryOverrideExample2/geometryOverrideExample2.cpp, geometryOverrideExample2/geometryOverrideExample2.h, geometryReplicator/geometryReplicator.cpp, gpuCache/CacheReaderAlembic.cpp, gpuCache/CacheReaderAlembic.h, gpuCache/CacheWriter.cpp, gpuCache/CacheWriter.h, gpuCache/CacheWriterAlembic.cpp, gpuCache/gpuCacheCmd.cpp, gpuCache/gpuCacheDrawOverride.cpp, gpuCache/gpuCacheDrawOverride.h, gpuCache/gpuCacheFrustum.h, gpuCache/gpuCacheGLPickingSelect.cpp, gpuCache/gpuCacheIsectUtil.cpp, gpuCache/gpuCacheIsectUtil.h, gpuCache/gpuCacheSample.cpp, gpuCache/gpuCacheSample.h, gpuCache/gpuCacheShapeNode.cpp, gpuCache/gpuCacheShapeNode.h, gpuCache/gpuCacheSpatialGrid.cpp, gpuCache/gpuCacheSpatialGrid.h, gpuCache/gpuCacheSpatialSubdivision.cpp, gpuCache/gpuCacheSpatialSubdivision.h, gpuCache/gpuCacheSubSceneOverride.cpp, gpuCache/gpuCacheUnitBoundingBox.cpp, gpuCache/gpuCacheUnitBoundingBox.h, gpuCache/gpuCacheUtil.h, gpuCache/gpuCacheVBOProxy.cpp, gpuCache/gpuCacheVBOProxy.h, hwPhongShader/hwPhongShader.cpp, MayaPluginForSpreticle/spReticleLoc.cpp, MayaPluginForSpreticle/spReticleLoc.h, rawfootPrintNode/rawfootPrintNode.cpp, simpleEvaluationDraw/simpleEvaluationDraw.cpp, simpleFluidEmitter/simpleFluidEmitter.cpp, squaresNode_noDepthTest/squaresNode_noDepthTest.cpp, swissArmyManip/swissArmyManip.cpp, tessellatedQuad/TessellatedQuadNode.cpp, tessellatedQuad/TessellatedQuadNode.h, uiDrawManager/uiDrawManager.cpp, viewDX11DeviceAccess/viewDX11DeviceAccess.cpp, viewRenderOverride/viewRenderOverride.h, and viewRenderOverride/viewRenderOverrideUserOperation.cpp.

Constructor & Destructor Documentation

MBoundingBox ( )

Default constructor.

Creates an empty bounding box.

MBoundingBox ( const MBoundingBox & src )

Copy constructor.

Parameters

[in] src bounding box to copy

MBoundingBox	(	const MPoint &	corner1,
		const MPoint &	corner2
	)

Constructor that creates a bounding box which contains the given points.

Each point will represent one corner of the box.

Parameters

[in]	corner1	first corner point
[in]	corner2	second corner point

Member Function Documentation

void transformUsing ( const MMatrix & matrix )

Apply the given transformation to this bounding box.

Parameters

[in] matrix transformation matrix

Examples:: AbcExport/AbcWriteJob.cpp, gpuCache/gpuCacheShapeNode.cpp, and simpleFluidEmitter/simpleFluidEmitter.cpp.

void expand ( const MPoint & point )

Expand the bounding box to include the given point.

Parameters

[in] point new point to include in the bounding box.

Examples:: AbcExport/AbcWriteJob.cpp, gpuCache/CacheReaderAlembic.cpp, gpuCache/gpuCacheCmd.cpp, gpuCache/gpuCacheSpatialGrid.cpp, gpuCache/gpuCacheSpatialSubdivision.cpp, and tessellatedQuad/TessellatedQuadNode.cpp.

void expand ( const MBoundingBox & box )

Expand the bounding box to include a second bounding box.

Parameters

[in] box bounding box to include in this bounding box.

bool contains ( const MPoint & point ) const

Returns true if the bounding box contains the given point.

Parameters

[in] point point to check for inclusion in this bounding box

Returns: true if the point is contained in this bounding box

bool intersects	(	const MBoundingBox &	box,
		double	tol = `0.0`
	)		const

Returns true if the bounding box intersects another given bounding box.

Parameters

[in]	box	bounding box to check for intersection
[in]	tol	tolerance of the intersection check

Returns: true if the bounding boxes intersect

double width ( ) const

Returns the width of the bounding box.

Returns: The width of the bounding box

Examples:: apiMeshShape/apiMeshShapeUI.cpp, gpuCache/gpuCacheIsectUtil.cpp, gpuCache/gpuCacheSpatialGrid.cpp, gpuCache/gpuCacheSpatialSubdivision.cpp, gpuCache/gpuCacheUnitBoundingBox.cpp, gpuCache/gpuCacheVBOProxy.cpp, rawfootPrintNode/rawfootPrintNode.cpp, and viewRenderOverride/viewRenderOverrideUserOperation.cpp.

double height ( ) const

Returns the height of the bounding box.

Returns: The height of the bounding box

Examples:: apiMeshShape/apiMeshShapeUI.cpp, gpuCache/gpuCacheIsectUtil.cpp, gpuCache/gpuCacheSpatialGrid.cpp, gpuCache/gpuCacheSpatialSubdivision.cpp, gpuCache/gpuCacheUnitBoundingBox.cpp, gpuCache/gpuCacheVBOProxy.cpp, rawfootPrintNode/rawfootPrintNode.cpp, and viewRenderOverride/viewRenderOverrideUserOperation.cpp.

double depth ( ) const

Returns the depth of the bounding box.

Returns: The depth of the bounding box

Examples:: apiMeshShape/apiMeshShapeUI.cpp, gpuCache/gpuCacheIsectUtil.cpp, gpuCache/gpuCacheSpatialGrid.cpp, gpuCache/gpuCacheSpatialSubdivision.cpp, gpuCache/gpuCacheUnitBoundingBox.cpp, gpuCache/gpuCacheVBOProxy.cpp, rawfootPrintNode/rawfootPrintNode.cpp, and viewRenderOverride/viewRenderOverrideUserOperation.cpp.

MPoint center ( ) const

Returns the center of the bounding box.

Returns: The center of the bounding box

Examples:: gpuCache/gpuCacheIsectUtil.cpp, gpuCache/gpuCacheSpatialGrid.cpp, gpuCache/gpuCacheUnitBoundingBox.cpp, and viewRenderOverride/viewRenderOverrideUserOperation.cpp.

MPoint min ( ) const

Returns the minimum point for the bounding box.

That is the point whose x, y, and z components represent the bounding box's minimum value in each dimension.

Returns: The minimum point of the bounding box

Examples:: AbcBullet/AbcWriteJob.cpp, AbcExport/AbcWriteJob.cpp, apiMeshShape/apiMeshShapeUI.cpp, apiMeshShape/apiMeshSubSceneOverride.cpp, gpuCache/CacheWriterAlembic.cpp, gpuCache/gpuCacheFrustum.h, gpuCache/gpuCacheIsectUtil.cpp, gpuCache/gpuCacheShapeNode.cpp, gpuCache/gpuCacheSpatialSubdivision.cpp, gpuCache/gpuCacheVBOProxy.cpp, hwPhongShader/hwPhongShader.cpp, rawfootPrintNode/rawfootPrintNode.cpp, simpleFluidEmitter/simpleFluidEmitter.cpp, viewDX11DeviceAccess/viewDX11DeviceAccess.cpp, and viewRenderOverride/viewRenderOverrideUserOperation.cpp.

MPoint max ( ) const

Returns the maximum point for the bounding box.

That is the point whose x, y, and z components represent the bounding box's maximum value in each dimension.

Returns: The maximum point of the bounding box

Examples:: AbcBullet/AbcWriteJob.cpp, AbcExport/AbcWriteJob.cpp, apiMeshShape/apiMeshSubSceneOverride.cpp, gpuCache/CacheWriterAlembic.cpp, gpuCache/gpuCacheFrustum.h, gpuCache/gpuCacheIsectUtil.cpp, gpuCache/gpuCacheShapeNode.cpp, gpuCache/gpuCacheSpatialSubdivision.cpp, hwPhongShader/hwPhongShader.cpp, rawfootPrintNode/rawfootPrintNode.cpp, simpleFluidEmitter/simpleFluidEmitter.cpp, viewDX11DeviceAccess/viewDX11DeviceAccess.cpp, and viewRenderOverride/viewRenderOverrideUserOperation.cpp.

MBoundingBox & operator= ( const MBoundingBox & other )

Assignment operator.

Parameters

[in] other bounding box to take value from

Returns: Reference to this bounding box

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

MBoundingBox.h
MBoundingBox.cpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation