Open CASCADE Technology  7.6.0
Public Member Functions

SelectMgr_FrustumBuilder Class Reference

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:
Inheritance graph
[legend]

Public Member Functions

 SelectMgr_FrustumBuilder ()
 Creates new frustum builder with empty matrices. More...
 
const Handle< Graphic3d_Camera > & Camera () const
 Returns current camera. More...
 
void SetCamera (const Handle< Graphic3d_Camera > &theCamera)
 Stores current camera. More...
 
void SetWindowSize (const Standard_Integer theWidth, const Standard_Integer theHeight)
 Stores current window width and height. More...
 
void SetViewport (const Standard_Real theX, const Standard_Real theY, const Standard_Real theWidth, const Standard_Real theHeight)
 Stores current viewport coordinates. More...
 
void InvalidateViewport ()
 
void WindowSize (Standard_Integer &theWidth, Standard_Integer &theHeight) const
 
Standard_Real SignedPlanePntDist (const SelectMgr_Vec3 &theEq, const SelectMgr_Vec3 &thePnt) const
 Calculates signed distance between plane with equation theEq and point thePnt. More...
 
gp_Pnt ProjectPntOnViewPlane (const Standard_Real &theX, const Standard_Real &theY, const Standard_Real &theZ) const
 Projects 2d screen point onto view frustum plane: theZ = 0 - near plane, theZ = 1 - far plane. More...
 
- Public Member Functions inherited from Standard_Transient
 Standard_Transient ()
 Empty constructor. More...
 
 Standard_Transient (const Standard_Transient &)
 Copy constructor – does nothing. More...
 
Standard_Transientoperator= (const Standard_Transient &)
 Assignment operator, needed to avoid copying reference counter. More...
 
virtual ~Standard_Transient ()
 Destructor must be virtual. More...
 
virtual void Delete () const
 Memory deallocator for transient classes. More...
 
virtual const opencascade::handle< Standard_Type > & DynamicType () const
 Returns a type descriptor about this object. More...
 
Standard_Boolean IsInstance (const opencascade::handle< Standard_Type > &theType) const
 Returns a true value if this is an instance of Type. More...
 
Standard_Boolean IsInstance (const Standard_CString theTypeName) const
 Returns a true value if this is an instance of TypeName. More...
 
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. More...
 
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. More...
 
Standard_TransientThis () 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. More...
 
Standard_Integer GetRefCount () const
 Get the reference counter of this object. More...
 
void IncrementRefCounter () const
 Increments the reference counter of this object. More...
 
Standard_Integer DecrementRefCounter () const
 Decrements the reference counter of this object; returns the decremented value. More...
 

Additional Inherited Members

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

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 Handle< Graphic3d_Camera >& SelectMgr_FrustumBuilder::Camera ( ) const
inline

Returns current camera.

◆ InvalidateViewport()

void SelectMgr_FrustumBuilder::InvalidateViewport ( )

◆ ProjectPntOnViewPlane()

gp_Pnt SelectMgr_FrustumBuilder::ProjectPntOnViewPlane ( const Standard_Real theX,
const Standard_Real theY,
const Standard_Real theZ 
) const

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

◆ SetCamera()

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

Stores current camera.

◆ SetViewport()

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

Stores current viewport coordinates.

◆ SetWindowSize()

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

Stores current window width and height.

◆ SignedPlanePntDist()

Standard_Real SelectMgr_FrustumBuilder::SignedPlanePntDist ( const SelectMgr_Vec3 theEq,
const SelectMgr_Vec3 thePnt 
) const

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

◆ WindowSize()

void SelectMgr_FrustumBuilder::WindowSize ( Standard_Integer theWidth,
Standard_Integer theHeight 
) const

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