Open CASCADE Technology 6.5.2
Public Member Functions
Visual3d_ViewMapping Class Reference

This class allows the definition of a projection and
a system of coordinates called NPC.
(Normalized Projection Coordinates).
The projection can be parallel or perspective.
References: The definitions are Phigs oriented.
Keywords: View, Mapping, Window, View Plane, Front Plane,
BackPlane, Projection Type, Reset, Projection
Summary of 3D View Mapping --
The view mapping transformation defines the --
window-to-viewport mapping of View Reference --
Coordinates (VRC) to Normalized Projection --
Coordinates (NPC). --
CAS.CADE supports two kinds of projection : --
Parallel : --
The Projection Reference Point (PRP) --
determines the direction of projection. --
Perspective : --
The projector lines converge at the --
Projection Reference Point (PRP). --
To define a view mapping transformation you --
must define : --
The Projection Type --
The Projection Reference Point (PRP) --
The Distance from Back Plane (BPD) --
The Distance from Front Plane (FPD) --
The Distance from View Plane (VPD) --
The Window in the View Plane. --

#include <Visual3d_ViewMapping.hxx>

Public Member Functions

void * operator new (size_t, void *anAddress)
void * operator new (size_t size)
void operator delete (void *anAddress)
 Visual3d_ViewMapping ()
 Creates a projection.

 Visual3d_ViewMapping (const Visual3d_TypeOfProjection AType, const Graphic3d_Vertex &PRP, const Standard_Real BPD, const Standard_Real FPD, const Standard_Real VPD, const Standard_Real WUmin, const Standard_Real WVmin, const Standard_Real WUmax, const Standard_Real WVmax)
 Creates a projection.

void SetBackPlaneDistance (const Standard_Real BPD)
 Modifies the back clipping plane.
Category: Methods to modify the class definition
Warning: Raises ViewMappingDefinitionError
if <PRP> is between the front and back planes.
if <PRP> is positioned on the view plane.
if the back plane is in front of the front plane.

void SetFrontPlaneDistance (const Standard_Real FPD)
 Modifies the front clipping plane.
Category: Methods to modify the class definition
Warning: Raises ViewMappingDefinitionError
if <PRP> is between the front and back planes.
if <PRP> is positioned on the view plane.
if the back plane is in front of the front plane.

void SetProjection (const Visual3d_TypeOfProjection AType)
 Modifies the type of projection.

void SetProjectionReferencePoint (const Graphic3d_Vertex &PRP)
 Modifies the PRP.
Category: Methods to modify the class definition
Warning: Raises ViewMappingDefinitionError
if <PRP> is between the front and back planes.
if <PRP> is positioned on the view plane.

void SetViewPlaneDistance (const Standard_Real VPD)
 Modifies the distance of the view plane of projection.
Category: Methods to modify the class definition
Warning: Raises ViewMappingDefinitionError
if <PRP> is positioned on the view plane.

void SetWindowLimit (const Standard_Real Umin, const Standard_Real Vmin, const Standard_Real Umax, const Standard_Real Vmax)
 Modifies the visible part of the projection plane.
Category: Methods to modify the class definition
Warning: Raises ViewMappingDefinitionError if the
specified window is invalid.

void SetCustomProjectionMatrix (const Handle< TColStd_HArray2OfReal > &Mat)
 Sets custom PROJECTION matrix for the OpenGl context

Standard_Real BackPlaneDistance () const
 Returns the distance from the back clipping plane
of this view mapping.

Standard_Real FrontPlaneDistance () const
 Returns the distance from the front clipping plane
of this view mapping.

Visual3d_TypeOfProjection Projection () const
 Returns the type of projection.

Graphic3d_Vertex ProjectionReferencePoint () const
 Returns the PRP.

Standard_Real ViewPlaneDistance () const
 Returns the distance from the projection plane.

void WindowLimit (Standard_Real &Umin, Standard_Real &Vmin, Standard_Real &Umax, Standard_Real &Vmax) const
 Returns the visible part of the projection plane.

Standard_Boolean IsCustomMatrix () const
 Returns whether the custom PROJECTION matrix is used.


Constructor & Destructor Documentation

Visual3d_ViewMapping::Visual3d_ViewMapping ( )
Visual3d_ViewMapping::Visual3d_ViewMapping ( const Visual3d_TypeOfProjection  AType,
const Graphic3d_Vertex PRP,
const Standard_Real  BPD,
const Standard_Real  FPD,
const Standard_Real  VPD,
const Standard_Real  WUmin,
const Standard_Real  WVmin,
const Standard_Real  WUmax,
const Standard_Real  WVmax 
)

Member Function Documentation

Standard_Real Visual3d_ViewMapping::BackPlaneDistance ( ) const
Standard_Real Visual3d_ViewMapping::FrontPlaneDistance ( ) const
Standard_Boolean Visual3d_ViewMapping::IsCustomMatrix ( ) const
void Visual3d_ViewMapping::operator delete ( void *  anAddress) [inline]
void* Visual3d_ViewMapping::operator new ( size_t  size) [inline]
void* Visual3d_ViewMapping::operator new ( size_t  ,
void *  anAddress 
) [inline]
Visual3d_TypeOfProjection Visual3d_ViewMapping::Projection ( ) const
Graphic3d_Vertex Visual3d_ViewMapping::ProjectionReferencePoint ( ) const
void Visual3d_ViewMapping::SetBackPlaneDistance ( const Standard_Real  BPD)
void Visual3d_ViewMapping::SetCustomProjectionMatrix ( const Handle< TColStd_HArray2OfReal > &  Mat)
void Visual3d_ViewMapping::SetFrontPlaneDistance ( const Standard_Real  FPD)
void Visual3d_ViewMapping::SetProjection ( const Visual3d_TypeOfProjection  AType)
void Visual3d_ViewMapping::SetProjectionReferencePoint ( const Graphic3d_Vertex PRP)
void Visual3d_ViewMapping::SetViewPlaneDistance ( const Standard_Real  VPD)
void Visual3d_ViewMapping::SetWindowLimit ( const Standard_Real  Umin,
const Standard_Real  Vmin,
const Standard_Real  Umax,
const Standard_Real  Vmax 
)
Standard_Real Visual3d_ViewMapping::ViewPlaneDistance ( ) const
void Visual3d_ViewMapping::WindowLimit ( Standard_Real Umin,
Standard_Real Vmin,
Standard_Real Umax,
Standard_Real Vmax 
) const

The documentation for this class was generated from the following file:
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines