Graphic3d_Layer Class Reference

Presentations list sorted within priorities. More...

#include <Graphic3d_Layer.hxx>

Inheritance diagram for Graphic3d_Layer:

Public Member Functions
	Graphic3d_Layer (Graphic3d_ZLayerId theId, const Handle< Select3D_BVHBuilder3d > &theBuilder)
	Initializes associated priority list and layer properties.
virtual	~Graphic3d_Layer ()
	Destructor.
Graphic3d_ZLayerId	LayerId () const
	Return layer id.
const Handle< Select3D_BVHBuilder3d > &	FrustumCullingBVHBuilder () const
	Returns BVH tree builder for frustum culling.
void	SetFrustumCullingBVHBuilder (const Handle< Select3D_BVHBuilder3d > &theBuilder)
	Assigns BVH tree builder for frustum culling.
Standard_Boolean	IsImmediate () const
	Return true if layer was marked with immediate flag.
const Graphic3d_ZLayerSettings &	LayerSettings () const
	Returns settings of the layer object.
void	SetLayerSettings (const Graphic3d_ZLayerSettings &theSettings)
	Sets settings of the layer object.
void	Add (const Graphic3d_CStructure *theStruct, Graphic3d_DisplayPriority thePriority, Standard_Boolean isForChangePriority=Standard_False)
bool	Remove (const Graphic3d_CStructure *theStruct, Graphic3d_DisplayPriority &thePriority, Standard_Boolean isForChangePriority=Standard_False)
	Remove structure and returns its priority, if the structure is not found, method returns negative value.
Standard_Integer	NbStructures () const
Standard_Integer	NbStructuresNotCulled () const
	Number of NOT culled structures in the layer.
Standard_Integer	NbPriorities () const
	Returns the number of available priority levels.
Standard_Boolean	Append (const Graphic3d_Layer &theOther)
	Append layer of acceptable type (with similar number of priorities or less). Returns Standard_False if the list can not be accepted.
const Graphic3d_ArrayOfIndexedMapOfStructure &	ArrayOfStructures () const
	Returns array of structures.
const Graphic3d_IndexedMapOfStructure &	Structures (Graphic3d_DisplayPriority thePriority) const
	Returns structures for specified priority.
void	InvalidateBVHData ()
	Marks BVH tree for given priority list as dirty and marks primitive set for rebuild.
void	InvalidateBoundingBox () const
	Marks cached bounding box as obsolete.
Bnd_Box	BoundingBox (Standard_Integer theViewId, const Handle< Graphic3d_Camera > &theCamera, Standard_Integer theWindowWidth, Standard_Integer theWindowHeight, Standard_Boolean theToIncludeAuxiliary) const
	Returns layer bounding box.
Standard_Real	considerZoomPersistenceObjects (Standard_Integer theViewId, const Handle< Graphic3d_Camera > &theCamera, Standard_Integer theWindowWidth, Standard_Integer theWindowHeight) const
	Returns zoom-scale factor.
void	UpdateCulling (Standard_Integer theViewId, const Graphic3d_CullingTool &theSelector, const Graphic3d_RenderingParams::FrustumCulling theFrustumCullingState)
	Update culling state - should be called before rendering. Traverses through BVH tree to determine which structures are in view volume.
bool	IsCulled () const
	Returns TRUE if layer is empty or has been discarded entirely by culling test.
Standard_Integer	NbOfTransformPersistenceObjects () const
	Returns number of transform persistence objects.
const Graphic3d_BvhCStructureSet &	CullableStructuresBVH () const
	Returns set of Graphic3d_CStructures structures for building BVH tree.
const Graphic3d_BvhCStructureSetTrsfPers &	CullableTrsfPersStructuresBVH () const
	Returns set of transform persistent Graphic3d_CStructures for building BVH tree.
const NCollection_IndexedMap< const Graphic3d_CStructure * > &	NonCullableStructures () const
	Returns indexed map of always rendered structures.
void	DumpJson (Standard_OStream &theOStream, Standard_Integer theDepth=-1) const
	Dumps the content of me into the stream.
Public Member Functions inherited from Standard_Transient
	Standard_Transient ()
	Empty constructor.
	Standard_Transient (const Standard_Transient &)
	Copy constructor – does nothing.
Standard_Transient &	operator= (const Standard_Transient &)
	Assignment operator, needed to avoid copying reference counter.
virtual	~Standard_Transient ()
	Destructor must be virtual.
virtual const opencascade::handle< Standard_Type > &	DynamicType () const
	Returns a type descriptor about this object.
Standard_Boolean	IsInstance (const opencascade::handle< Standard_Type > &theType) const
	Returns a true value if this is an instance of Type.
Standard_Boolean	IsInstance (const Standard_CString theTypeName) const
	Returns a true value if this is an instance of TypeName.
Standard_Boolean	IsKind (const opencascade::handle< Standard_Type > &theType) const
	Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
Standard_Boolean	IsKind (const Standard_CString theTypeName) const
	Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
Standard_Transient *	This () const
	Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero.
Standard_Integer	GetRefCount () const noexcept
	Get the reference counter of this object.
void	IncrementRefCounter () noexcept
	Increments the reference counter of this object.
Standard_Integer	DecrementRefCounter () noexcept
	Decrements the reference counter of this object; returns the decremented value.
virtual void	Delete () const
	Memory deallocator for transient classes.

Protected Member Functions
void	updateBVH () const
	Updates BVH trees if their state has been invalidated.

Additional Inherited Members
Public Types inherited from Standard_Transient
typedef void	base_type
	Returns a type descriptor about this object.
Static Public Member Functions inherited from Standard_Transient
static constexpr const char *	get_type_name ()
	Returns a type descriptor about this object.
static const opencascade::handle< Standard_Type > &	get_type_descriptor ()
	Returns type descriptor of Standard_Transient class.

Detailed Description

Presentations list sorted within priorities.

Constructor & Destructor Documentation

Graphic3d_Layer()

Graphic3d_Layer::Graphic3d_Layer	(	Graphic3d_ZLayerId	theId,
		const Handle< Select3D_BVHBuilder3d > &	theBuilder
	)

Initializes associated priority list and layer properties.

~Graphic3d_Layer()

virtual Graphic3d_Layer::~Graphic3d_Layer ( )

virtual

Destructor.

Member Function Documentation

Add()

void Graphic3d_Layer::Add	(	const Graphic3d_CStructure *	theStruct,
		Graphic3d_DisplayPriority	thePriority,
		Standard_Boolean	isForChangePriority = Standard_False
	)

Append()

Standard_Boolean Graphic3d_Layer::Append

(

const Graphic3d_Layer &

theOther

)

Append layer of acceptable type (with similar number of priorities or less). Returns Standard_False if the list can not be accepted.

ArrayOfStructures()

const Graphic3d_ArrayOfIndexedMapOfStructure & Graphic3d_Layer::ArrayOfStructures ( ) const

inline

Returns array of structures.

BoundingBox()

Bnd_Box Graphic3d_Layer::BoundingBox	(	Standard_Integer	theViewId,
		const Handle< Graphic3d_Camera > &	theCamera,
		Standard_Integer	theWindowWidth,
		Standard_Integer	theWindowHeight,
		Standard_Boolean	theToIncludeAuxiliary
	)		const

Returns layer bounding box.

Parameters

theViewId	view index to consider View Affinity in structure
theCamera	camera definition
theWindowWidth	viewport width (for applying transformation-persistence)
theWindowHeight	viewport height (for applying transformation-persistence)
theToIncludeAuxiliary	consider also auxiliary presentations (with infinite flag or with trihedron transformation persistence)

Returns

computed bounding box

considerZoomPersistenceObjects()

Standard_Real Graphic3d_Layer::considerZoomPersistenceObjects	(	Standard_Integer	theViewId,
		const Handle< Graphic3d_Camera > &	theCamera,
		Standard_Integer	theWindowWidth,
		Standard_Integer	theWindowHeight
	)		const

Returns zoom-scale factor.

CullableStructuresBVH()

const Graphic3d_BvhCStructureSet & Graphic3d_Layer::CullableStructuresBVH ( ) const

inline

Returns set of Graphic3d_CStructures structures for building BVH tree.

CullableTrsfPersStructuresBVH()

const Graphic3d_BvhCStructureSetTrsfPers & Graphic3d_Layer::CullableTrsfPersStructuresBVH ( ) const

inline

Returns set of transform persistent Graphic3d_CStructures for building BVH tree.

DumpJson()

void Graphic3d_Layer::DumpJson	(	Standard_OStream &	theOStream,
		Standard_Integer	theDepth = -1
	)		const

Dumps the content of me into the stream.

FrustumCullingBVHBuilder()

const Handle< Select3D_BVHBuilder3d > & Graphic3d_Layer::FrustumCullingBVHBuilder ( ) const

inline

Returns BVH tree builder for frustum culling.

InvalidateBoundingBox()

void Graphic3d_Layer::InvalidateBoundingBox ( ) const

inline

Marks cached bounding box as obsolete.

InvalidateBVHData()

void Graphic3d_Layer::InvalidateBVHData

(

)

Marks BVH tree for given priority list as dirty and marks primitive set for rebuild.

IsCulled()

bool Graphic3d_Layer::IsCulled ( ) const

inline

Returns TRUE if layer is empty or has been discarded entirely by culling test.

IsImmediate()

Standard_Boolean Graphic3d_Layer::IsImmediate ( ) const

inline

Return true if layer was marked with immediate flag.

LayerId()

Graphic3d_ZLayerId Graphic3d_Layer::LayerId ( ) const

inline

Return layer id.

LayerSettings()

const Graphic3d_ZLayerSettings & Graphic3d_Layer::LayerSettings ( ) const

inline

Returns settings of the layer object.

NbOfTransformPersistenceObjects()

Standard_Integer Graphic3d_Layer::NbOfTransformPersistenceObjects ( ) const

inline

Returns number of transform persistence objects.

NbPriorities()

Standard_Integer Graphic3d_Layer::NbPriorities ( ) const

inline

Returns the number of available priority levels.

NbStructures()

Standard_Integer Graphic3d_Layer::NbStructures ( ) const

inline

Returns

the number of structures

NbStructuresNotCulled()

Standard_Integer Graphic3d_Layer::NbStructuresNotCulled ( ) const

inline

Number of NOT culled structures in the layer.

NonCullableStructures()

const NCollection_IndexedMap< const Graphic3d_CStructure * > & Graphic3d_Layer::NonCullableStructures ( ) const

inline

Returns indexed map of always rendered structures.

Remove()

bool Graphic3d_Layer::Remove	(	const Graphic3d_CStructure *	theStruct,
		Graphic3d_DisplayPriority &	thePriority,
		Standard_Boolean	isForChangePriority = Standard_False
	)

Remove structure and returns its priority, if the structure is not found, method returns negative value.

SetFrustumCullingBVHBuilder()

void Graphic3d_Layer::SetFrustumCullingBVHBuilder ( const Handle< Select3D_BVHBuilder3d > &  theBuilder )

inline

Assigns BVH tree builder for frustum culling.

SetLayerSettings()

void Graphic3d_Layer::SetLayerSettings

(

const Graphic3d_ZLayerSettings &

theSettings

)

Sets settings of the layer object.

Structures()

const Graphic3d_IndexedMapOfStructure & Graphic3d_Layer::Structures ( Graphic3d_DisplayPriority  thePriority ) const

inline

Returns structures for specified priority.

updateBVH()

void Graphic3d_Layer::updateBVH ( ) const

protected

Updates BVH trees if their state has been invalidated.

UpdateCulling()

void Graphic3d_Layer::UpdateCulling	(	Standard_Integer	theViewId,
		const Graphic3d_CullingTool &	theSelector,
		const Graphic3d_RenderingParams::FrustumCulling	theFrustumCullingState
	)

Update culling state - should be called before rendering. Traverses through BVH tree to determine which structures are in view volume.

---

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

• Graphic3d_Layer.hxx