Code_TYMPAN  4.2.0
Industrial site acoustic simulation
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Accelerator Class Reference

Base class for accelerators. More...

#include <Accelerator.h>

Inheritance diagram for Accelerator:
Inheritance graph
[legend]
Collaboration diagram for Accelerator:
Collaboration graph
[legend]

Public Member Functions

 Accelerator ()
 Constructors. More...
 
 Accelerator (std::vector< Shape *> *_shapes, BBox &_globalBox)
 
 Accelerator (const Accelerator &other)
 Copy constructor. More...
 
virtual ~Accelerator ()
 Destructor. More...
 
leafTreatment::treatment getIntersectionChoice ()
 Get/Set the Intersection choice. More...
 
void setIntersectionChoice (leafTreatment::treatment _intersectionChoice=leafTreatment::FIRST)
 
virtual bool build ()
 Build this accelerator. More...
 
virtual decimal traverse (Ray *r, std::list< Intersection > &result) const
 Run this accelerator. More...
 

Protected Member Functions

void defineLeafFunction ()
 To define leaf function. More...
 

Protected Attributes

decimal(* pLeafTreatmentFunction )(std::list< Intersection > &, decimal)
 Pointer to the treatment function of leaf. More...
 
leafTreatment::treatment intersectionChoice
 Intersection choice. More...
 
std::vector< Shape * > * shapes
 Vector of pointers to shapes. More...
 
BBox globalBox
 Global bounding box. More...
 

Detailed Description

Base class for accelerators.

Definition at line 26 of file Accelerator.h.

Constructor & Destructor Documentation

◆ Accelerator() [1/3]

Accelerator::Accelerator ( )
inline

Constructors.

Definition at line 31 of file Accelerator.h.

Here is the call graph for this function:

◆ Accelerator() [2/3]

Accelerator::Accelerator ( std::vector< Shape *> *  _shapes,
BBox _globalBox 
)
inline

Definition at line 32 of file Accelerator.h.

Here is the call graph for this function:

◆ Accelerator() [3/3]

Accelerator::Accelerator ( const Accelerator other)
inline

Copy constructor.

Definition at line 39 of file Accelerator.h.

◆ ~Accelerator()

virtual Accelerator::~Accelerator ( )
inlinevirtual

Destructor.

Definition at line 47 of file Accelerator.h.

Member Function Documentation

◆ build()

virtual bool Accelerator::build ( )
inlinevirtual

Build this accelerator.

Reimplemented in KdtreeAccelerator, GridAccelerator, BruteForceAccelerator, and BvhAccelerator.

Definition at line 53 of file Accelerator.h.

Here is the caller graph for this function:

◆ defineLeafFunction()

void Accelerator::defineLeafFunction ( )
inlineprotected

To define leaf function.

Definition at line 59 of file Accelerator.h.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ getIntersectionChoice()

leafTreatment::treatment Accelerator::getIntersectionChoice ( )
inline

Get/Set the Intersection choice.

Definition at line 50 of file Accelerator.h.

◆ setIntersectionChoice()

void Accelerator::setIntersectionChoice ( leafTreatment::treatment  _intersectionChoice = leafTreatment::FIRST)
inline

Definition at line 51 of file Accelerator.h.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ traverse()

virtual decimal Accelerator::traverse ( Ray r,
std::list< Intersection > &  result 
) const
inlinevirtual

Run this accelerator.

Reimplemented in KdtreeAccelerator, GridAccelerator, BruteForceAccelerator, and BvhAccelerator.

Definition at line 55 of file Accelerator.h.

Here is the caller graph for this function:

Member Data Documentation

◆ globalBox

BBox Accelerator::globalBox
protected

Global bounding box.

Definition at line 86 of file Accelerator.h.

◆ intersectionChoice

leafTreatment::treatment Accelerator::intersectionChoice
protected

Intersection choice.

Definition at line 83 of file Accelerator.h.

◆ pLeafTreatmentFunction

decimal(* Accelerator::pLeafTreatmentFunction) (std::list< Intersection > &, decimal)
protected

Pointer to the treatment function of leaf.

Definition at line 81 of file Accelerator.h.

◆ shapes

std::vector<Shape*>* Accelerator::shapes
protected

Vector of pointers to shapes.

Definition at line 85 of file Accelerator.h.


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