opal::VolumeQueryResult Struct Reference

#include <VolumeSensor.h>

List of all members.

Public Member Functions
OPAL_DECL	VolumeQueryResult ()
OPAL_DECL	VolumeQueryResult (const VolumeQueryResult &result)
OPAL_DECL	~VolumeQueryResult ()
OPAL_DECL void OPAL_CALL	operator= (const VolumeQueryResult &result)
OPAL_DECL void OPAL_CALL	internal_addSolid (Solid *s)
OPAL_DECL unsigned int OPAL_CALL	getNumSolids () const
OPAL_DECL Solid *OPAL_CALL	getSolid (unsigned int i) const
OPAL_DECL void OPAL_CALL	internal_clearSolids ()
OPAL_DECL void OPAL_CALL	internal_removeSolid (const Solid *s)
Private Attributes
std::vector< Solid * >	mSolidList

---

Detailed Description

A data structure containing information about a specific volume query.

Definition at line 41 of file VolumeSensor.h.

---

Constructor & Destructor Documentation

OPAL_DECL opal::VolumeQueryResult::VolumeQueryResult (   )  [inline]

Definition at line 43 of file VolumeSensor.h.

OPAL_DECL opal::VolumeQueryResult::VolumeQueryResult (  const VolumeQueryResult &  result  )  [inline]

Copy constructor. Definition at line 48 of file VolumeSensor.h.

OPAL_DECL opal::VolumeQueryResult::~VolumeQueryResult (   )  [inline]

Definition at line 53 of file VolumeSensor.h. References internal_clearSolids().

---

Member Function Documentation

OPAL_DECL unsigned int OPAL_CALL opal::VolumeQueryResult::getNumSolids (   )  const [inline]

Returns the number of Solids in the results. Definition at line 77 of file VolumeSensor.h.

OPAL_DECL Solid* OPAL_CALL opal::VolumeQueryResult::getSolid (  unsigned int  i  )  const [inline]

Definition at line 82 of file VolumeSensor.h.

OPAL_DECL void OPAL_CALL opal::VolumeQueryResult::internal_addSolid (  Solid *  s  )  [inline]

Adds a Solid pointer to the list of results. Definition at line 70 of file VolumeSensor.h. Referenced by opal::ODESimulator::internal_addCollidedSolid().

OPAL_DECL void OPAL_CALL opal::VolumeQueryResult::internal_clearSolids (   )  [inline]

Removes all Solids from the results. Definition at line 88 of file VolumeSensor.h. Referenced by opal::ODESimulator::internal_queryVolume(), and ~VolumeQueryResult().

OPAL_DECL void OPAL_CALL opal::VolumeQueryResult::internal_removeSolid (  const Solid *  s  )  [inline]

Removes a specified Solid from the list of collided Solids. Definition at line 94 of file VolumeSensor.h.

OPAL_DECL void OPAL_CALL opal::VolumeQueryResult::operator= (  const VolumeQueryResult &  result  )  [inline]

Makes a deep copy. Definition at line 59 of file VolumeSensor.h. References mSolidList.

---

Member Data Documentation

std::vector<Solid*> opal::VolumeQueryResult::mSolidList [private]

A list of Solids that were found in a volume query. Definition at line 109 of file VolumeSensor.h. Referenced by operator=().

---

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

• VolumeSensor.h

---