prtx::GenerateContext Class Reference

#include <GenerateContext.h>

Public Types
using	OcclusionSets = std::vector< const prt::OcclusionSet * >
using	OcclusionSetsVector = std::vector< OcclusionSets >

Public Member Functions
	GenerateContext (const GenerateContext &)=delete
prt::Cache *	getCache ()
prt::Cache const *	getCache () const
prt::Callbacks *	getCallbacks ()
const prtx::InitialShape *	getInitialShape (size_t i) const
size_t	getInitialShapeCount () const
prt::OcclusionSet::Handle	getOcclusionHandle (size_t i) const
const OcclusionSets &	getOcclusionSets (size_t i) const
GenerateContext &	operator= (const GenerateContext &)=delete

Protected Member Functions
	GenerateContext (const prt::InitialShape *const *initialShapes, const prt::OcclusionSet::Handle *occlusionHandles, size_t initialShapeCount, prt::Callbacks *callbacks, prt::Cache *cache, const OcclusionSetsVector &occlusionSets)
	GenerateContext (const prt::InitialShape *const *initialShapes, size_t initialShapeCount, prt::Callbacks *callbacks, prt::Cache *cache, prt::OcclusionSet *writableOcclusionSet)

Detailed Description

A GenerateContext is created for each prt::generate() call. It basically contains the parameters of the prt::generate() call.

Constructor & Destructor Documentation

GenerateContext() [1/2]

prtx::GenerateContext::GenerateContext ( const prt::InitialShape *const *  initialShapes, const prt::OcclusionSet::Handle *  occlusionHandles, size_t  initialShapeCount, prt::Callbacks *  callbacks, prt::Cache *  cache, const OcclusionSetsVector &  occlusionSets  )

protected

Constructor for read-only access to occlusionSet (i.e. to use occlusion set to resolve occlusion queries).

GenerateContext() [2/2]

prtx::GenerateContext::GenerateContext ( const prt::InitialShape *const *  initialShapes, size_t  initialShapeCount, prt::Callbacks *  callbacks, prt::Cache *  cache, prt::OcclusionSet *  writableOcclusionSet  )

protected

Constructor for write access to occlusionSet (i.e. for generateOccluders() call)

Member Function Documentation

getCache()

prt::Cache* prtx::GenerateContext::getCache ( )

inline

Returns

pointer to the (optional) prt::Cache implementation. Might be nullptr.

getCallbacks()

prt::Callbacks* prtx::GenerateContext::getCallbacks ( )

inline

Returns

pointer to the prt::Callbacks implementation.

getInitialShape()

const prtx::InitialShape* prtx::GenerateContext::getInitialShape ( size_t  i ) const

inline

Parameters

i	Index of InitialShape to return.

Returns

InitialShape with index i.

getInitialShapeCount()

size_t prtx::GenerateContext::getInitialShapeCount ( ) const

inline

Returns

the number of initial shapes.

getOcclusionHandle()

prt::OcclusionSet::Handle prtx::GenerateContext::getOcclusionHandle ( size_t  i ) const

inline

Optionally, there is a occlusion handle for every initial shape.

Parameters

i	Index of occlusion handle to return.

Returns

occlusion handle with index i if set, 0 (= no handle) otherwise.

getOcclusionSets()

const OcclusionSets& prtx::GenerateContext::getOcclusionSets ( size_t  i ) const

inline

Parameters

i	Index of InitialShape.

Returns

pointers to the (optional) read-only prt::OcclusionSet which contains the occluders of an initial shape identified by the occlusion handles. Might be empty.

---

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

• GenerateContext.h