The purpose of this class is to provide unified interface for building selecting frustum depending on current camera projection and orientation matrices, window size and viewport parameters. More...

#include <SelectMgr_FrustumBuilder.hxx>

Inheritance diagram for SelectMgr_FrustumBuilder:

[legend]

Public Member Functions
	SelectMgr_FrustumBuilder ()
	Creates new frustum builder with empty matrices.

const occ::handle< Graphic3d_Camera > &	Camera () const
	Returns current camera.

void	SetCamera (const occ::handle< Graphic3d_Camera > &theCamera)
	Stores current camera.

void	SetWindowSize (const int theWidth, const int theHeight)
	Stores current window width and height.

void	SetViewport (const double theX, const double theY, const double theWidth, const double theHeight)
	Stores current viewport coordinates.

void	InvalidateViewport ()

void	WindowSize (int &theWidth, int &theHeight) const

double	SignedPlanePntDist (const NCollection_Vec3< double > &theEq, const NCollection_Vec3< double > &thePnt) const
	Calculates signed distance between plane with equation theEq and point thePnt.

gp_Pnt	ProjectPntOnViewPlane (const double &theX, const double &theY, const double &theZ) const
	Projects 2d screen point onto view frustum plane: theZ = 0 - near plane, theZ = 1 - far plane.

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 ()=default
	Destructor must be virtual.

virtual const opencascade::handle< Standard_Type > &	DynamicType () const
	Returns a type descriptor about this object.

bool	IsInstance (const opencascade::handle< Standard_Type > &theType) const
	Returns a true value if this is an instance of Type.

bool	IsInstance (const char *const theTypeName) const
	Returns a true value if this is an instance of TypeName.

bool	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.

bool	IsKind (const char *const 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.

int	GetRefCount () const noexcept
	Get the reference counter of this object.

void	IncrementRefCounter () noexcept
	Increments the reference counter of this object. Uses relaxed memory ordering since incrementing only requires atomicity, not synchronization with other memory operations.

int	DecrementRefCounter () noexcept
	Decrements the reference counter of this object; returns the decremented value. Uses release ordering for the decrement to ensure all writes to the object are visible before the count reaches zero. An acquire fence is added only when the count reaches zero, ensuring proper synchronization before deletion. This is more efficient than using acq_rel for every decrement.

virtual void	Delete () const
	Memory deallocator for transient classes.

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

The purpose of this class is to provide unified interface for building selecting frustum depending on current camera projection and orientation matrices, window size and viewport parameters.

Constructor & Destructor Documentation

◆ SelectMgr_FrustumBuilder()

SelectMgr_FrustumBuilder::SelectMgr_FrustumBuilder ( )

Creates new frustum builder with empty matrices.

Member Function Documentation

◆ Camera()

const occ::handle< Graphic3d_Camera > & SelectMgr_FrustumBuilder::Camera ( ) const

inline

Returns current camera.

◆ InvalidateViewport()

void SelectMgr_FrustumBuilder::InvalidateViewport ( )

◆ ProjectPntOnViewPlane()

gp_Pnt SelectMgr_FrustumBuilder::ProjectPntOnViewPlane	(	const double &	theX,
		const double &	theY,
		const double &	theZ ) const

Projects 2d screen point onto view frustum plane: theZ = 0 - near plane, theZ = 1 - far plane.

◆ SetCamera()

void SelectMgr_FrustumBuilder::SetCamera ( const occ::handle< Graphic3d_Camera > & theCamera )

Stores current camera.

◆ SetViewport()

void SelectMgr_FrustumBuilder::SetViewport	(	const double	theX,
		const double	theY,
		const double	theWidth,
		const double	theHeight )

Stores current viewport coordinates.

◆ SetWindowSize()

void SelectMgr_FrustumBuilder::SetWindowSize	(	const int	theWidth,
		const int	theHeight )

Stores current window width and height.

◆ SignedPlanePntDist()

double SelectMgr_FrustumBuilder::SignedPlanePntDist	(	const NCollection_Vec3< double > &	theEq,
		const NCollection_Vec3< double > &	thePnt ) const

Calculates signed distance between plane with equation theEq and point thePnt.

◆ WindowSize()

void SelectMgr_FrustumBuilder::WindowSize	(	int &	theWidth,
		int &	theHeight ) const

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

SelectMgr_FrustumBuilder.hxx

Public Member Functions

Additional Inherited Members