axom::quest::DynamicGrayBlockData Class Reference

Verbose BlockDataType for an InOutOctree. More...

#include </home/docs/checkouts/readthedocs.org/user_builds/axom/checkouts/v0.5.0/src/axom/quest/InOutOctree.hpp>

Public Types
enum	{ NO_VERTEX = -1 }
using	VertexIndex = axom::IndexType
using	TriangleIndex = axom::IndexType
using	TriangleList = std::vector< TriangleIndex >

Public Member Functions
	DynamicGrayBlockData ()
	Default constructor for an InOutLeafData. More...
	DynamicGrayBlockData (VertexIndex vInd, bool isLeaf)
	Constructor for an InOutLeafData. More...
	DynamicGrayBlockData (const DynamicGrayBlockData &other)
	Copy constructor for an DynamicGrayBlockData instance. More...
DynamicGrayBlockData &	operator= (const DynamicGrayBlockData &other)
	Assignment operator for an InOutLeafData instance. More...
bool	isLeaf () const
void	setLeafFlag (bool isLeaf)
bool	hasVertex () const
	Checks whether there is a vertex associated with this leaf. More...
void	setVertex (VertexIndex vInd)
void	clearVertex ()
VertexIndex &	vertexIndex ()
const VertexIndex &	vertexIndex () const
bool	hasTriangles () const
void	reserveTriangles (int count)
int	numTriangles () const
void	addTriangle (TriangleIndex tInd)
const TriangleList &	triangles () const
TriangleList &	triangles ()

Friends
bool	operator== (const DynamicGrayBlockData &lhs, const DynamicGrayBlockData &rhs)
	Removes all indexed data from this leaf. More...

Detailed Description

Verbose BlockDataType for an InOutOctree.

Note

Used when generating the octree.

Member Typedef Documentation

VertexIndex

using axom::quest::DynamicGrayBlockData::VertexIndex = axom::IndexType

TriangleIndex

using axom::quest::DynamicGrayBlockData::TriangleIndex = axom::IndexType

TriangleList

using axom::quest::DynamicGrayBlockData::TriangleList = std::vector<TriangleIndex>

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
NO_VERTEX

Constructor & Destructor Documentation

DynamicGrayBlockData() [1/3]

axom::quest::DynamicGrayBlockData::DynamicGrayBlockData ( )

inline

Default constructor for an InOutLeafData.

DynamicGrayBlockData() [2/3]

axom::quest::DynamicGrayBlockData::DynamicGrayBlockData ( VertexIndex  vInd, bool  isLeaf  )

inline

Constructor for an InOutLeafData.

Parameters

vInd	The index of a vertex (optional; default is to not set a vertex)

DynamicGrayBlockData() [3/3]

axom::quest::DynamicGrayBlockData::DynamicGrayBlockData ( const DynamicGrayBlockData &  other )

inline

Copy constructor for an DynamicGrayBlockData instance.

Member Function Documentation

operator=()

DynamicGrayBlockData& axom::quest::DynamicGrayBlockData::operator= ( const DynamicGrayBlockData &  other )

inline

Assignment operator for an InOutLeafData instance.

References axom::copy().

isLeaf()

bool axom::quest::DynamicGrayBlockData::isLeaf ( ) const

inline

Predicate to determine if the associated block is a leaf in the octree

Referenced by axom::quest::InOutOctree< DIM >::generateIndex(), and axom::quest::operator<<().

setLeafFlag()

void axom::quest::DynamicGrayBlockData::setLeafFlag ( bool  isLeaf )

inline

Sets a flag to determine whether the associated block is a leaf or internal

Referenced by axom::quest::InOutOctree< DIM >::generateIndex().

hasVertex()

bool axom::quest::DynamicGrayBlockData::hasVertex ( ) const

inline

Checks whether there is a vertex associated with this leaf.

Referenced by axom::quest::operator<<().

setVertex()

void axom::quest::DynamicGrayBlockData::setVertex ( VertexIndex  vInd )

inline

Sets the vertex associated with this leaf

Referenced by axom::quest::InOutOctree< DIM >::generateIndex().

clearVertex()

void axom::quest::DynamicGrayBlockData::clearVertex ( )

inline

Clears the associated vertex index

vertexIndex() [1/2]

VertexIndex& axom::quest::DynamicGrayBlockData::vertexIndex ( )

inline

Accessor for the index of the vertex associated with this leaf

Referenced by axom::quest::InOutOctree< DIM >::generateIndex(), and axom::quest::operator<<().

vertexIndex() [2/2]

const VertexIndex& axom::quest::DynamicGrayBlockData::vertexIndex ( ) const

inline

Constant accessor for the index of the vertex associated with this leaf

hasTriangles()

bool axom::quest::DynamicGrayBlockData::hasTriangles ( ) const

inline

Check whether this Leaf has any associated triangles

Referenced by axom::quest::operator<<().

reserveTriangles()

void axom::quest::DynamicGrayBlockData::reserveTriangles ( int  count )

inline

Reserves space for a given number of triangles

Parameters

count

The number of triangles for which to reserve space

numTriangles()

int axom::quest::DynamicGrayBlockData::numTriangles ( ) const

inline

Find the number of triangles associated with this leaf

Referenced by axom::quest::InOutOctree< DIM >::generateIndex(), and axom::quest::operator<<().

addTriangle()

void axom::quest::DynamicGrayBlockData::addTriangle ( TriangleIndex  tInd )

inline

Associates the surface triangle with the given index with this block

Referenced by axom::quest::InOutOctree< DIM >::generateIndex().

triangles() [1/2]

const TriangleList& axom::quest::DynamicGrayBlockData::triangles ( ) const

inline

Returns a const reference to the list of triangle indexes associated with the block

Referenced by axom::quest::InOutOctree< DIM >::generateIndex(), and axom::quest::operator<<().

triangles() [2/2]

TriangleList& axom::quest::DynamicGrayBlockData::triangles ( )

inline

Returns a reference to the list of triangle indexes associated with the block

Friends And Related Function Documentation

operator==

bool operator== ( const DynamicGrayBlockData &  lhs, const DynamicGrayBlockData &  rhs  )

friend

Removes all indexed data from this leaf.

Equality operator to determine if two DynamicGrayBlockData instances are equivalent

---

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

• /home/docs/checkouts/readthedocs.org/user_builds/axom/checkouts/v0.5.0/src/axom/quest/InOutOctree.hpp