EGSnrc C++ class library  Report PIRS-898 (2021)
Iwan Kawrakow, Ernesto Mainegra-Hing, Frederic Tessier, Reid Townson and Blake Walters
Public Member Functions | Protected Attributes | List of all members
EGS_ShapeCollection Class Reference

A shape collection. More...

#include <egs_shape_collection.h>

Inheritance diagram for EGS_ShapeCollection:
EGS_BaseShape EGS_Object

Public Member Functions

 EGS_ShapeCollection (const vector< EGS_BaseShape * > &Shapes, const vector< EGS_Float > &Probs, const string &Name="", EGS_ObjectFactory *f=0)
 
EGS_Vector getPoint (EGS_RandomGenerator *rndm)
 
bool supportsDirectionMethod () const
 
EGS_Float area () const
 
void getPointSourceDirection (const EGS_Vector &Xo, EGS_RandomGenerator *rndm, EGS_Vector &u, EGS_Float &wt)
 
- Public Member Functions inherited from EGS_BaseShape
 EGS_BaseShape (const string &Name="", EGS_ObjectFactory *f=0)
 Construct a shape named Name.
 
virtual ~EGS_BaseShape ()
 Destructor. Deletes T if it is not null.
 
virtual EGS_Vector getRandomPoint (EGS_RandomGenerator *rndm)
 Returns a random 3D vector. More...
 
void setTransformation (EGS_Input *inp)
 Set the transformation attached to this shape. More...
 
void setTransformation (EGS_AffineTransform *t)
 Set the transformation attached to this shape. More...
 
const EGS_AffineTransformgetTransform () const
 Get a pointer to the affine transformation attached to this shape.
 
- Public Member Functions inherited from EGS_Object
 EGS_Object (const string &Name="", EGS_ObjectFactory *f=0)
 Create an EGS_Object named Name belonging to the object factory f. More...
 
 EGS_Object (EGS_Input *inp, EGS_ObjectFactory *f=0)
 Create an EGS_Object from the information pointed to by inp that belongs to object factory f. More...
 
const string & getObjectName () const
 Get the object name.
 
void setObjectName (const string &Name)
 Set the object name to Name.
 
const string & getObjectType () const
 Get the object type.
 
virtual EGS_ObjectcreateObject (EGS_Input *inp)
 Create an object from the infromation pointed to by inp. More...
 
void setName (EGS_Input *inp)
 Set the name of the object from the information provided by inp. More...
 
int ref ()
 Increase the reference count to this object.
 
int deref ()
 Decrease the reference count to this object.
 
void setFactory (EGS_ObjectFactory *f)
 Set the factory to which the object belongs. More...
 

Protected Attributes

int nshape
 
EGS_BaseShape ** shapes
 
EGS_SimpleAliasTabletable
 
- Protected Attributes inherited from EGS_BaseShape
EGS_AffineTransformT
 The affine transformation attached to the shape.
 
- Protected Attributes inherited from EGS_Object
string name
 The object name.
 
string otype
 The object type.
 
int nref
 Number of references to the object.
 
EGS_ObjectFactoryfactory
 The factory this object belongs to.
 

Additional Inherited Members

- Static Public Member Functions inherited from EGS_BaseShape
static EGS_BaseShapecreateShape (EGS_Input *inp)
 Create a shape from the information pointed to by inp. More...
 
static EGS_BaseShapegetShape (const string &Name)
 Get a pointer to the shape named Name. More...
 
- Static Public Member Functions inherited from EGS_Object
static string getUniqueName (const EGS_Object *o=0)
 Create and return a unique object name. More...
 
static void deleteObject (EGS_Object *o)
 Delete an object. More...
 

Detailed Description

A shape collection.

This is a shape made from other shapes of any type $s_1, s_2, ..., s_n$ where the random position is picked from the $s_j$'s with probabilities $p_j$ defined by the user. A shape collection is defined using

:start shape:
    library = egs_shape_collection
    :start shape:
        definition of the first shape in the collection
    :stop shape:
    :start shape:
        definition of the second shape in the collection
    :stop shape:
    ...
    :start shape:
        definition of the last shape in the collection
    :stop shape:
    probabilities = p1 p2 ... pn
:stop shape:

A shape collection can be used to pick surface points if all of the shapes in the collection support the getPointSourceDirection() method.

Definition at line 95 of file egs_shape_collection.h.


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