opensurgsim
Public Member Functions | List of all members
SurgSim::Particles::RandomPointGenerator Class Reference

RandomPointGenerator will generate points based on the shape passed. More...

#include <RandomPointGenerator.h>

Inheritance diagram for SurgSim::Particles::RandomPointGenerator:
SurgSim::Particles::PointGenerator

Public Member Functions

 RandomPointGenerator ()
 Constructor.
 
SurgSim::Math::Vector3d pointInShape (std::shared_ptr< SurgSim::Math::Shape > shape) override
 Generates one point inside the given shape. More...
 
SurgSim::Math::Vector3d pointOnShape (std::shared_ptr< SurgSim::Math::Shape > shape) override
 Generates one point on the surface of the given shape. More...
 
- Public Member Functions inherited from SurgSim::Particles::PointGenerator
 PointGenerator ()
 Constructor.
 
virtual ~PointGenerator ()
 Destructor.
 
void seed (unsigned int val)
 Set the seed to the given value. More...
 

Additional Inherited Members

- Protected Attributes inherited from SurgSim::Particles::PointGenerator
std::mt19937 m_generator
 
std::uniform_real_distribution< double > m_openOneOneDistribution
 
std::uniform_real_distribution< double > m_closedOneOneDistribution
 
std::uniform_real_distribution< double > m_closedZeroOneDistribution
 
std::uniform_real_distribution< double > m_closedZeroOpenOneDistribution
 

Detailed Description

RandomPointGenerator will generate points based on the shape passed.

Internally, this class maintains a list of PointGenerators for each supported shape. The list gets populated when RandomPointGenerator is constructed.

See also
PointGenerator

Member Function Documentation

§ pointInShape()

Math::Vector3d SurgSim::Particles::RandomPointGenerator::pointInShape ( std::shared_ptr< SurgSim::Math::Shape shape)
overridevirtual

Generates one point inside the given shape.

Parameters
shapeThe shape inside which a point will be generated.
Returns
A point inside the shape, shape is assumed to be located at the origin.

Implements SurgSim::Particles::PointGenerator.

§ pointOnShape()

Math::Vector3d SurgSim::Particles::RandomPointGenerator::pointOnShape ( std::shared_ptr< SurgSim::Math::Shape shape)
overridevirtual

Generates one point on the surface of the given shape.

Parameters
shapeThe shape on which a point will be generated.
Returns
A point on the surface of the shape, shape is assumed to be located at the origin.

Implements SurgSim::Particles::PointGenerator.


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