Interface for obtaining view transformation parameters. More...

#include <IVtk_IView.hxx>

Inheritance diagram for IVtk_IView:

[legend]

Public Types
typedef occ::handle< IVtk_IView >	Handle

Public Types inherited from IVtk_Interface
typedef occ::handle< IVtk_Interface >	Handle

Public Types inherited from Standard_Transient
typedef void	base_type
	Returns a type descriptor about this object.

Public Member Functions
	~IVtk_IView () override=default
	Destructor.

virtual bool	IsPerspective () const =0

virtual double	GetDistance () const =0

virtual void	GetEyePosition (double &theX, double &theY, double &theZ) const =0

virtual void	GetPosition (double &theX, double &theY, double &theZ) const =0

virtual void	GetViewUp (double &theDx, double &theDy, double &theDz) const =0

virtual void	GetDirectionOfProjection (double &theDx, double &theDy, double &theDz) const =0

virtual void	GetScale (double &theX, double &theY, double &theZ) const =0

virtual double	GetParallelScale () const =0

virtual double	GetViewAngle () const =0

virtual void	GetClippingRange (double &theZNear, double &theZFar) const =0

virtual double	GetAspectRatio () const =0

virtual void	GetViewCenter (double &theX, double &theY) const =0

virtual void	GetWindowSize (int &theX, int &theY) const =0
	Gets window size in screen coordinates in pixels.

virtual void	GetCamera (NCollection_Mat4< double > &theProj, NCollection_Mat4< double > &theOrient, bool &theIsOrtho) const =0
	Gets camera projection and orientation matrices.

virtual bool	DisplayToWorld (const gp_XY &theDisplayPnt, gp_XYZ &theWorldPnt) const =0
	Converts 3D display coordinates into 3D world coordinates.

virtual void	GetViewport (double &theX, double &theY, double &theWidth, double &theHeight) const =0
	Gets viewport coordinates.

Public Member Functions inherited from IVtk_Interface
	~IVtk_Interface () override=default

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

Interface for obtaining view transformation parameters.

These parameters are used by selection algorithm to compute projections of selectable (active) 3D shapes.

Member Typedef Documentation

◆ Handle

typedef occ::handle<IVtk_IView> IVtk_IView::Handle

Constructor & Destructor Documentation

◆ ~IVtk_IView()

IVtk_IView::~IVtk_IView ( )

overridedefault

Destructor.

Member Function Documentation

◆ DisplayToWorld()

virtual bool IVtk_IView::DisplayToWorld	(	const gp_XY &	theDisplayPnt,
		gp_XYZ &	theWorldPnt ) const

pure virtual

Converts 3D display coordinates into 3D world coordinates.

Parameters

[in]	theDisplayPnt	2d point of display coordinates
[out]	theWorldPnt	3d point of world coordinates

Returns: true if conversion was successful, false otherwise

Implemented in IVtkVTK_View.

◆ GetAspectRatio()

virtual double IVtk_IView::GetAspectRatio ( ) const

pure virtual

Returns: The current view the aspect ratio

Implemented in IVtkVTK_View.

◆ GetCamera()

virtual void IVtk_IView::GetCamera	(	NCollection_Mat4< double > &	theProj,
		NCollection_Mat4< double > &	theOrient,
		bool &	theIsOrtho ) const

pure virtual

Gets camera projection and orientation matrices.

Implemented in IVtkVTK_View.

◆ GetClippingRange()

virtual void IVtk_IView::GetClippingRange	(	double &	theZNear,
		double &	theZFar ) const

pure virtual

Returns: The location of the near and far clipping planes along the direction of projection

Implemented in IVtkVTK_View.

◆ GetDirectionOfProjection()

virtual void IVtk_IView::GetDirectionOfProjection	(	double &	theDx,
		double &	theDy,
		double &	theDz ) const

pure virtual

Returns: The projection direction vector of this view

Implemented in IVtkVTK_View.

◆ GetDistance()

virtual double IVtk_IView::GetDistance ( ) const

pure virtual

Returns: The focal distance of the view

Implemented in IVtkVTK_View.

◆ GetEyePosition()

virtual void IVtk_IView::GetEyePosition	(	double &	theX,
		double &	theY,
		double &	theZ ) const

pure virtual

Returns: The world coordinates of the camera position

Implemented in IVtkVTK_View.

◆ GetParallelScale()

virtual double IVtk_IView::GetParallelScale ( ) const

pure virtual

Returns: The current view's zoom factor (for parallel projection)

Implemented in IVtkVTK_View.

◆ GetPosition()

virtual void IVtk_IView::GetPosition	(	double &	theX,
		double &	theY,
		double &	theZ ) const

pure virtual

Returns: The world coordinates of the view position

Implemented in IVtkVTK_View.

◆ GetScale()

virtual void IVtk_IView::GetScale	(	double &	theX,
		double &	theY,
		double &	theZ ) const

pure virtual

Returns: Three doubles containing scale components of the view transformation

Implemented in IVtkVTK_View.

◆ GetViewAngle()

virtual double IVtk_IView::GetViewAngle ( ) const

pure virtual

Returns: The current view angle (for perspective projection)

Implemented in IVtkVTK_View.

◆ GetViewCenter()

virtual void IVtk_IView::GetViewCenter	(	double &	theX,
		double &	theY ) const

pure virtual

Returns: Two doubles containing the display coordinates of the view window center

Implemented in IVtkVTK_View.

◆ GetViewport()

virtual void IVtk_IView::GetViewport	(	double &	theX,
		double &	theY,
		double &	theWidth,
		double &	theHeight ) const

pure virtual

Gets viewport coordinates.

Implemented in IVtkVTK_View.

◆ GetViewUp()

virtual void IVtk_IView::GetViewUp	(	double &	theDx,
		double &	theDy,
		double &	theDz ) const

pure virtual

Returns: The "view up" direction of the view

Implemented in IVtkVTK_View.

◆ GetWindowSize()

virtual void IVtk_IView::GetWindowSize	(	int &	theX,
		int &	theY ) const

pure virtual

Gets window size in screen coordinates in pixels.

Implemented in IVtkVTK_View.

◆ IsPerspective()

virtual bool IVtk_IView::IsPerspective ( ) const

pure virtual

Returns: true if this is a perspective view, and false otherwise.

Implemented in IVtkVTK_View.

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

IVtk_IView.hxx

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Handle

Constructor & Destructor Documentation

◆ ~IVtk_IView()

Member Function Documentation

◆ DisplayToWorld()

◆ GetAspectRatio()

◆ GetCamera()

◆ GetClippingRange()

◆ GetDirectionOfProjection()

◆ GetDistance()

◆ GetEyePosition()

◆ GetParallelScale()

◆ GetPosition()

◆ GetScale()

◆ GetViewAngle()

◆ GetViewCenter()

◆ GetViewport()

◆ GetViewUp()

◆ GetWindowSize()

◆ IsPerspective()