Open CASCADE Technology 6.6.0
Public Member Functions
Visual3d_ContextView Class Reference

This class manages the creation and update of
a visualization context for one view in the viewer.
A context is defined by :
Antialiasing.
ZClipping.
Depth-cueing.
The type of visualization.
The light sources.

#include <Visual3d_ContextView.hxx>

Public Member Functions

 Visual3d_ContextView ()
 Creates a context from default values

Aliasing : OFF
BackZClipping : OFF
FrontZClipping : OFF
Depth-cueing : OFF
Light source : 0
Clipping plane : 0
Type Of Visualization : TOV_WIREFRAME
Type Of Model : TOM_NONE
Type Of SurfaceDetail : TOSD_NONE

void SetSurfaceDetail (const Visual3d_TypeOfSurfaceDetail TOSD)
 Selects the kind of rendering
default to: TOSD_NONE

void SetTextureEnv (const Handle< Graphic3d_TextureEnv > &ATexture)
 Sets the environment texture to use
no environment texture by default

void SetAliasingOn ()
 Activates antialiasing.
Antialiasing can be activated on all the structures
in the view

void SetAliasingOff ()
 Deactivates the antialiasing.

void SetDepthCueingBackPlane (const Standard_Real ABack)
 Modifies the back depth-cueing plane.
Category: Methods to modify the class definition
Warning: Raises DepthCueingDefinitionError if <BackPlane>
is front of <FrontPlane> and DepthCueing is ON.

void SetDepthCueingFrontPlane (const Standard_Real ABack)
 Modifies the front depth-cueing plane.
Category: Methods to modify the class definition
Warning: Raises DepthCueingDefinitionError if <BackPlane> is
front of <FrontPlane> and DepthCueing is ON.

void SetDepthCueingOn ()
 Activates the depth-cueing.
Depth-cueing can be activated on all structures
present in the view.
Category: Methods to modify the class definition
Warning: Raises DepthCueingDefinitionError if <BackPlane> is
front of <FrontPlane>.

void SetDepthCueingOff ()
 Deactivates the depth-cueing.

void SetClipPlaneOn (const Handle< Visual3d_ClipPlane > &AClipPlane)
 Activates the clipping plane <AClipPlane>

void SetClipPlaneOff (const Handle< Visual3d_ClipPlane > &AClipPlane)
 Deactivates the clipping plane <AClipPlane>

void SetLightOn (const Handle< Visual3d_Light > &ALight)
 Activates the light source <ALight>

void SetLightOff (const Handle< Visual3d_Light > &ALight)
 Deactivates the light source <ALight>

void SetModel (const Visual3d_TypeOfModel AModel)
 Modifies the shading model when the type of
visualization is TOV_SHADING

TypeOfModel : TOM_NONE
TOM_INTERP_COLOR
TOM_FACET
TOM_VERTEX


void SetVisualization (const Visual3d_TypeOfVisualization AVisual)
 Modifies the mode of visualization.

TypeOfVisualization : TOV_WIREFRAME
TOV_SHADING


void SetZClippingBackPlane (const Standard_Real ABack)
 Modifies the back Z-clipping plane.
Category: Methods to modify the class definition
Warning: Raises ZClippingDefinitionError if <BackPlane> is
front of <FrontPlane> and ZClipping is ON.

void SetZClippingFrontPlane (const Standard_Real AFront)
 Modifies the front Z-clipping plane.
Category: Methods to modify the class definition
Warning: Raises ZClippingDefinitionError if <BackPlane> is
front of <FrontPlane> and ZClipping is ON.

void SetZClippingOn ()
 Activates the Z-clipping planes defined by
SetZClippingFrontPlane and SetZClippingBackPlane.
Category: Methods to modify the class definition
Warning: Raises ZClippingDefinitionError if <BackPlane> is
front of <FrontPlane>.

void SetZClippingOff ()
 Deactivates the Z-clipping planes defined by
SetFrontPlane and SetBackPlane.

void SetFrontZClippingOn ()
 Activates the front Z-clipping plane defined by
SetFrontPlane method.

void SetFrontZClippingOff ()
 Deactivates the front Z-clipping plane defined by
SetFrontPlane method.

void SetBackZClippingOn ()
 Activates the back Z-clipping plane defined by
SetBackPlane method.
Category: Methods to modify the class definition
Warning: Raises ZClippingDefinitionError if <BackPlane> is
front of <FrontPlane>.

void SetBackZClippingOff ()
 Deactivates the back Z-clipping plane defined by
SetBackPlane method.

Handle_Visual3d_HSetOfClipPlane ActivatedClipPlanes () const
 Returns the group of active clipping planes
in the view of context <me>.

Standard_Integer NumberOfActivatedClipPlanes () const
 Returns the number of active clipping planes
in the view of context <me>.

Handle_Visual3d_ClipPlane ActivatedClipPlane (const Standard_Integer AnIndex) const
Handle_Visual3d_HSetOfLight ActivatedLights () const
 Returns the group of active light sources
in the view of context <me>.

Standard_Integer NumberOfActivatedLights () const
 Returns the number of active light sources
in the view of context <me>.

Handle_Visual3d_Light ActivatedLight (const Standard_Integer AnIndex) const
Standard_Boolean AliasingIsOn () const
 Returns the activity of the aliasing.

Standard_Boolean BackZClippingIsOn () const
 Returns the activity of the ZClipping.

Standard_Real DepthCueingBackPlane () const
 Returns the definition of the back depth-cueing plane.

Standard_Real DepthCueingFrontPlane () const
 Returns the definition of the front depth-cueing plane.

Standard_Boolean DepthCueingIsOn () const
 Returns the activity of the depth-cueing.

Standard_Boolean FrontZClippingIsOn () const
 Returns the activity of the ZClipping.

Visual3d_TypeOfModel Model () const
 Returns the shading model.

Visual3d_TypeOfVisualization Visualization () const
 Returns the mode of visualization.

Standard_Real ZClippingBackPlane () const
 Returns the definition of the back Z-clipping plane.

Standard_Real ZClippingFrontPlane () const
 Returns the definition of the front Z-clipping plane.

Visual3d_TypeOfSurfaceDetail SurfaceDetail () const
Handle_Graphic3d_TextureEnv TextureEnv () const

Constructor & Destructor Documentation

Visual3d_ContextView::Visual3d_ContextView ( )

Member Function Documentation

Handle_Visual3d_ClipPlane Visual3d_ContextView::ActivatedClipPlane ( const Standard_Integer  AnIndex) const
Handle_Visual3d_HSetOfClipPlane Visual3d_ContextView::ActivatedClipPlanes ( ) const
Handle_Visual3d_Light Visual3d_ContextView::ActivatedLight ( const Standard_Integer  AnIndex) const
Handle_Visual3d_HSetOfLight Visual3d_ContextView::ActivatedLights ( ) const
Standard_Boolean Visual3d_ContextView::AliasingIsOn ( ) const
Standard_Boolean Visual3d_ContextView::BackZClippingIsOn ( ) const
Standard_Real Visual3d_ContextView::DepthCueingBackPlane ( ) const
Standard_Real Visual3d_ContextView::DepthCueingFrontPlane ( ) const
Standard_Boolean Visual3d_ContextView::DepthCueingIsOn ( ) const
Standard_Boolean Visual3d_ContextView::FrontZClippingIsOn ( ) const
Visual3d_TypeOfModel Visual3d_ContextView::Model ( ) const
Standard_Integer Visual3d_ContextView::NumberOfActivatedClipPlanes ( ) const
Standard_Integer Visual3d_ContextView::NumberOfActivatedLights ( ) const
void Visual3d_ContextView::SetAliasingOff ( )
void Visual3d_ContextView::SetAliasingOn ( )
void Visual3d_ContextView::SetBackZClippingOff ( )
void Visual3d_ContextView::SetBackZClippingOn ( )
void Visual3d_ContextView::SetClipPlaneOff ( const Handle< Visual3d_ClipPlane > &  AClipPlane)
void Visual3d_ContextView::SetClipPlaneOn ( const Handle< Visual3d_ClipPlane > &  AClipPlane)
void Visual3d_ContextView::SetDepthCueingBackPlane ( const Standard_Real  ABack)
void Visual3d_ContextView::SetDepthCueingFrontPlane ( const Standard_Real  ABack)
void Visual3d_ContextView::SetDepthCueingOff ( )
void Visual3d_ContextView::SetDepthCueingOn ( )
void Visual3d_ContextView::SetFrontZClippingOff ( )
void Visual3d_ContextView::SetFrontZClippingOn ( )
void Visual3d_ContextView::SetLightOff ( const Handle< Visual3d_Light > &  ALight)
void Visual3d_ContextView::SetLightOn ( const Handle< Visual3d_Light > &  ALight)
void Visual3d_ContextView::SetModel ( const Visual3d_TypeOfModel  AModel)
void Visual3d_ContextView::SetSurfaceDetail ( const Visual3d_TypeOfSurfaceDetail  TOSD)
void Visual3d_ContextView::SetTextureEnv ( const Handle< Graphic3d_TextureEnv > &  ATexture)
void Visual3d_ContextView::SetVisualization ( const Visual3d_TypeOfVisualization  AVisual)
void Visual3d_ContextView::SetZClippingBackPlane ( const Standard_Real  ABack)
void Visual3d_ContextView::SetZClippingFrontPlane ( const Standard_Real  AFront)
void Visual3d_ContextView::SetZClippingOff ( )
void Visual3d_ContextView::SetZClippingOn ( )
Visual3d_TypeOfSurfaceDetail Visual3d_ContextView::SurfaceDetail ( ) const
Handle_Graphic3d_TextureEnv Visual3d_ContextView::TextureEnv ( ) const
Visual3d_TypeOfVisualization Visual3d_ContextView::Visualization ( ) const
Standard_Real Visual3d_ContextView::ZClippingBackPlane ( ) const
Standard_Real Visual3d_ContextView::ZClippingFrontPlane ( ) const

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