cee::ug::PartHitItems Class Reference

Class for storing identifier for a part (state id, geometry id, part id/index) and optionally also a list of element indices within this part. More...

Public Member Functions

 PartHitItems ()
 Constructs an empty part hit items. More...
 
 PartHitItems (const PartHitItems &other)
 Copy constructor. More...
 
PartHitItemsoperator= (const PartHitItems &other)
 Assignment operator. More...
 
int stateId () const
 Returns the state id of the hit item. More...
 
void setStateId (int stateId)
 Sets the state id. More...
 
size_t frameIndex () const
 Returns the frame index of the hit item. More...
 
void setFrameIndex (size_t frameIndex)
 Sets the frame index of the hit item. More...
 
size_t geometryIndex () const
 Returns the global geometry index, used to e.g. get the geometry from a DataState. More...
 
void setGeometryIndex (size_t geometryIndex)
 Sets the geometry index. More...
 
int partId () const
 Returns the part id of the hit item. More...
 
void setPartId (int itemId)
 Sets the part id. More...
 
size_t partIndex () const
 Returns the index of the part withing the geometry. More...
 
void setPartIndex (size_t partIndex)
 Sets the index of of the part within the geometry. More...
 
const std::vector< unsigned int > & elementIndices () const
 Returns the element indices stored in this items. More...
 
void setElementIndices (const std::vector< unsigned int > &indices)
 Sets the element indices for this item. More...
 
size_t elementCount () const
 Returns the number of element indices stored in this item. More...
 
HitItem elementHitItem (size_t elementIndex) const
 Returns the element at the given index as a HitItem. More...
 

Detailed Description

Class for storing identifier for a part (state id, geometry id, part id/index) and optionally also a list of element indices within this part.

This class is used to store the result of a regionIntersect() done on a UnstructGridModel.

See also
Ray
UnstructGridModel

Constructor & Destructor Documentation

cee::ug::PartHitItems::PartHitItems ( )

Constructs an empty part hit items.

cee::ug::PartHitItems::PartHitItems ( const PartHitItems other)

Copy constructor.

Member Function Documentation

size_t cee::ug::PartHitItems::elementCount ( ) const

Returns the number of element indices stored in this item.

cee::ug::HitItem cee::ug::PartHitItems::elementHitItem ( size_t  elementIndex) const

Returns the element at the given index as a HitItem.

const std::vector< unsigned int > & cee::ug::PartHitItems::elementIndices ( ) const

Returns the element indices stored in this items.

Zero-based indices for the elements in the specified part.

size_t cee::ug::PartHitItems::frameIndex ( ) const

Returns the frame index of the hit item.

size_t cee::ug::PartHitItems::geometryIndex ( ) const

Returns the global geometry index, used to e.g. get the geometry from a DataState.

PartHitItems & cee::ug::PartHitItems::operator= ( const PartHitItems other)

Assignment operator.

int cee::ug::PartHitItems::partId ( ) const

Returns the part id of the hit item.

size_t cee::ug::PartHitItems::partIndex ( ) const

Returns the index of the part withing the geometry.

void cee::ug::PartHitItems::setElementIndices ( const std::vector< unsigned int > &  indices)

Sets the element indices for this item.

Zero-based indices for the elements in the specified part.

void cee::ug::PartHitItems::setFrameIndex ( size_t  frameIndex)

Sets the frame index of the hit item.

void cee::ug::PartHitItems::setGeometryIndex ( size_t  geometryIndex)

Sets the geometry index.

void cee::ug::PartHitItems::setPartId ( int  itemId)

Sets the part id.

void cee::ug::PartHitItems::setPartIndex ( size_t  partIndex)

Sets the index of of the part within the geometry.

void cee::ug::PartHitItems::setStateId ( int  stateId)

Sets the state id.

int cee::ug::PartHitItems::stateId ( ) const

Returns the state id of the hit item.