public

Inheritance Graph

graph BT
	Sample
	click Sample "classMinSG_1_1AGVS_1_1Sample"

Description

Structure to store a single sample. The sample consists of the ray that is cast and the resulting values in the forward and backward direction.

Parameters

value_t
Eitherfloatordouble

Public Types

   
   
typedef Geometry::_Vec3 < value_t > vec3_t
   
typedef Geometry::_Ray < vec3_t > ray_t

Public Functions

   
   
  Sample( ray_t ray)
   
GeometryNode * getForwardResult() const
   
GeometryNode * getBackwardResult() const
   
void setForwardResult( GeometryNode * result, value_t intersection)
   
void setBackwardResult( GeometryNode * result, value_t intersection)
   
bool hasForwardResult() const
   
bool hasBackwardResult() const
   
const ray_t & getForwardRay() const
   
ray_t getBackwardRay() const
   
value_t getForwardIntersection() const
   
value_t getBackwardIntersection() const
   
vec3_t getOrigin() const
   
vec3_t getForwardTerminationPoint() const
   
vec3_t getBackwardTerminationPoint() const
   
uint8_t getNumHits() const
   
uint8_t getDistributionId() const
   
void setDistributionId(uint8_t id)

Documentation

typedef
MinSG::AGVS::Sample::vec3_t

public
 
 
typedef Geometry::_Vec3 < value_t > vec3_t

Defined in MinSG/Ext/AdaptiveGlobalVisibilitySampling/Sample.h:32

typedef
MinSG::AGVS::Sample::ray_t

public
 
 
typedef Geometry::_Ray < vec3_t > ray_t

Defined in MinSG/Ext/AdaptiveGlobalVisibilitySampling/Sample.h:33

function
MinSG::AGVS::Sample::Sample

public inline
     
     
Sample( ray_t ray )

Create a new, empty sample by setting only its forward ray.

Parameters

ray
Forward ray defining the sample

Defined in MinSG/Ext/AdaptiveGlobalVisibilitySampling/Sample.h:72

function
MinSG::AGVS::Sample::getForwardResult

public const inline
   
   
GeometryNode * getForwardResult( ) const

Defined in MinSG/Ext/AdaptiveGlobalVisibilitySampling/Sample.h:81

function
MinSG::AGVS::Sample::getBackwardResult

public const inline
   
   
GeometryNode * getBackwardResult( ) const

Defined in MinSG/Ext/AdaptiveGlobalVisibilitySampling/Sample.h:84

function
MinSG::AGVS::Sample::setForwardResult

public inline
     
     
void setForwardResult( GeometryNode * result,
  value_t intersection
)    

Defined in MinSG/Ext/AdaptiveGlobalVisibilitySampling/Sample.h:88

function
MinSG::AGVS::Sample::setBackwardResult

public inline
     
     
void setBackwardResult( GeometryNode * result,
  value_t intersection
)    

Defined in MinSG/Ext/AdaptiveGlobalVisibilitySampling/Sample.h:92

function
MinSG::AGVS::Sample::hasForwardResult

public const inline
   
   
bool hasForwardResult( ) const

Defined in MinSG/Ext/AdaptiveGlobalVisibilitySampling/Sample.h:97

function
MinSG::AGVS::Sample::hasBackwardResult

public const inline
   
   
bool hasBackwardResult( ) const

Defined in MinSG/Ext/AdaptiveGlobalVisibilitySampling/Sample.h:100

function
MinSG::AGVS::Sample::getForwardRay

public const inline
   
   
const ray_t & getForwardRay( ) const

Defined in MinSG/Ext/AdaptiveGlobalVisibilitySampling/Sample.h:104

function
MinSG::AGVS::Sample::getBackwardRay

public const inline
   
   
ray_t getBackwardRay( ) const

Defined in MinSG/Ext/AdaptiveGlobalVisibilitySampling/Sample.h:107

function
MinSG::AGVS::Sample::getForwardIntersection

public const inline
   
   
value_t getForwardIntersection( ) const

Defined in MinSG/Ext/AdaptiveGlobalVisibilitySampling/Sample.h:111

function
MinSG::AGVS::Sample::getBackwardIntersection

public const inline
   
   
value_t getBackwardIntersection( ) const

Defined in MinSG/Ext/AdaptiveGlobalVisibilitySampling/Sample.h:114

function
MinSG::AGVS::Sample::getOrigin

public const inline
   
   
vec3_t getOrigin( ) const

Defined in MinSG/Ext/AdaptiveGlobalVisibilitySampling/Sample.h:118

function
MinSG::AGVS::Sample::getForwardTerminationPoint

public const inline
   
   
vec3_t getForwardTerminationPoint( ) const

Defined in MinSG/Ext/AdaptiveGlobalVisibilitySampling/Sample.h:121

function
MinSG::AGVS::Sample::getBackwardTerminationPoint

public const inline
   
   
vec3_t getBackwardTerminationPoint( ) const

Defined in MinSG/Ext/AdaptiveGlobalVisibilitySampling/Sample.h:124

function
MinSG::AGVS::Sample::getNumHits

public const inline
   
   
uint8_t getNumHits( ) const

Return the number of objects the sample has hit. It can be zero (no objects hit), one (object hit in either forward or backward direction), or two (objects hit in both directions).

Returns

0, 1, or 2

Defined in MinSG/Ext/AdaptiveGlobalVisibilitySampling/Sample.h:135

function
MinSG::AGVS::Sample::getDistributionId

public const inline
   
   
uint8_t getDistributionId( ) const

Get the distribution that generated this sample.

Parameters

id
Identifier of the distribution

Defined in MinSG/Ext/AdaptiveGlobalVisibilitySampling/Sample.h:144

function
MinSG::AGVS::Sample::setDistributionId

public inline
     
     
void setDistributionId( uint8_t id )

Set the distribution that generated this sample.

Parameters

id
Identifier of the distribution

Defined in MinSG/Ext/AdaptiveGlobalVisibilitySampling/Sample.h:152