Open CASCADE Technology  7.7.0
Public Types | Public Member Functions
IVtkVTK_View Class Reference

ICamera implementation for VTK. More...

#include <IVtkVTK_View.hxx>

Inheritance diagram for IVtkVTK_View:
Inheritance graph
[legend]

Public Types

typedef Handle< IVtkVTK_ViewHandle
 
- Public Types inherited from IVtk_IView
typedef Handle< IVtk_IViewHandle
 
- Public Types inherited from IVtk_Interface
typedef Handle< IVtk_InterfaceHandle
 
- Public Types inherited from Standard_Transient
typedef void base_type
 Returns a type descriptor about this object. More...
 

Public Member Functions

 IVtkVTK_View (vtkRenderer *theRenderer)
 
virtual ~IVtkVTK_View ()
 Destructor. More...
 
virtual bool IsPerspective () const override
 
virtual double GetDistance () const override
 
virtual void GetEyePosition (double &theX, double &theY, double &theZ) const override
 
virtual void GetPosition (double &theX, double &theY, double &theZ) const override
 
virtual void GetViewUp (double &theDx, double &theDy, double &theDz) const override
 
virtual void GetDirectionOfProjection (double &theDx, double &theDy, double &theDz) const override
 
virtual void GetScale (double &theX, double &theY, double &theZ) const override
 
virtual double GetParallelScale () const override
 
virtual double GetViewAngle () const override
 
virtual void GetClippingRange (double &theZNear, double &theZFar) const override
 
virtual double GetAspectRatio () const override
 
virtual void GetViewCenter (double &theX, double &theY) const override
 
virtual void GetWindowSize (int &theX, int &theY) const override
 Gets window size in screen coordinates in pixels. More...
 
virtual void GetCamera (Graphic3d_Mat4d &theProj, Graphic3d_Mat4d &theOrient, Standard_Boolean &theIsOrtho) const override
 Gets camera projection and orientation matrices. More...
 
virtual void GetViewport (Standard_Real &theX, Standard_Real &theY, Standard_Real &theWidth, Standard_Real &theHeight) const override
 Gets viewport coordinates. More...
 
virtual bool DisplayToWorld (const gp_XY &theDisplayPnt, gp_XYZ &theWorldPnt) const override
 Converts 3D display coordinates into 3D world coordinates. More...
 
- Public Member Functions inherited from IVtk_IView
virtual ~IVtk_IView ()
 Destructor. More...
 
- Public Member Functions inherited from IVtk_Interface
virtual ~IVtk_Interface ()
 
- 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

- 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

ICamera implementation for VTK.

This class is used for obtaining view transformation parameters. These parameters are used by selection algorithm to compute projections of selectable (active) 3D shapes.

Member Typedef Documentation

◆ Handle

Constructor & Destructor Documentation

◆ IVtkVTK_View()

IVtkVTK_View::IVtkVTK_View ( vtkRenderer *  theRenderer)

◆ ~IVtkVTK_View()

virtual IVtkVTK_View::~IVtkVTK_View ( )
virtual

Destructor.

Member Function Documentation

◆ DisplayToWorld()

virtual bool IVtkVTK_View::DisplayToWorld ( const gp_XY theDisplayPnt,
gp_XYZ theWorldPnt 
) const
overridevirtual

Converts 3D display coordinates into 3D world coordinates.

Parameters
[in]theDisplayPnt2d point of display coordinates
[out]theWorldPnt3d point of world coordinates
Returns
true if conversion was successful, false otherwise

Implements IVtk_IView.

◆ GetAspectRatio()

virtual double IVtkVTK_View::GetAspectRatio ( ) const
overridevirtual
Returns
The current view the aspect ratio

Implements IVtk_IView.

◆ GetCamera()

virtual void IVtkVTK_View::GetCamera ( Graphic3d_Mat4d theProj,
Graphic3d_Mat4d theOrient,
Standard_Boolean theIsOrtho 
) const
overridevirtual

Gets camera projection and orientation matrices.

Implements IVtk_IView.

◆ GetClippingRange()

virtual void IVtkVTK_View::GetClippingRange ( double &  theZNear,
double &  theZFar 
) const
overridevirtual
Returns
The location of the near and far clipping planes along the direction of projection

Implements IVtk_IView.

◆ GetDirectionOfProjection()

virtual void IVtkVTK_View::GetDirectionOfProjection ( double &  theDx,
double &  theDy,
double &  theDz 
) const
overridevirtual
Returns
The projection direction vector of this view

Implements IVtk_IView.

◆ GetDistance()

virtual double IVtkVTK_View::GetDistance ( ) const
overridevirtual
Returns
The focal distance of the view

Implements IVtk_IView.

◆ GetEyePosition()

virtual void IVtkVTK_View::GetEyePosition ( double &  theX,
double &  theY,
double &  theZ 
) const
overridevirtual
Returns
The world coordinates of the camera position

Implements IVtk_IView.

◆ GetParallelScale()

virtual double IVtkVTK_View::GetParallelScale ( ) const
overridevirtual
Returns
The current view's zoom factor (for parallel projection)

Implements IVtk_IView.

◆ GetPosition()

virtual void IVtkVTK_View::GetPosition ( double &  theX,
double &  theY,
double &  theZ 
) const
overridevirtual
Returns
The world coordinates of the view position

Implements IVtk_IView.

◆ GetScale()

virtual void IVtkVTK_View::GetScale ( double &  theX,
double &  theY,
double &  theZ 
) const
overridevirtual
Returns
Three doubles containing scale components of the view transformation

Implements IVtk_IView.

◆ GetViewAngle()

virtual double IVtkVTK_View::GetViewAngle ( ) const
overridevirtual
Returns
The current view angle (for perspective projection)

Implements IVtk_IView.

◆ GetViewCenter()

virtual void IVtkVTK_View::GetViewCenter ( double &  theX,
double &  theY 
) const
overridevirtual
Returns
Two doubles containing the display coordinates of the view window center

Implements IVtk_IView.

◆ GetViewport()

virtual void IVtkVTK_View::GetViewport ( Standard_Real theX,
Standard_Real theY,
Standard_Real theWidth,
Standard_Real theHeight 
) const
overridevirtual

Gets viewport coordinates.

Implements IVtk_IView.

◆ GetViewUp()

virtual void IVtkVTK_View::GetViewUp ( double &  theDx,
double &  theDy,
double &  theDz 
) const
overridevirtual
Returns
The "view up" direction of the view

Implements IVtk_IView.

◆ GetWindowSize()

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

Gets window size in screen coordinates in pixels.

Implements IVtk_IView.

◆ IsPerspective()

virtual bool IVtkVTK_View::IsPerspective ( ) const
overridevirtual
Returns
true if this is a perspective view, and false otherwise.

Implements IVtk_IView.


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