OCC Main Page | Visualization | Toolkits | Packages | Class Hierarchy | Data Structures | File List | Data Fields | Globals

Visualization
TKV3d
Visual3d


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

void * operator new (size_t, void *anAddress)
void * operator new (size_t size)
void operator delete (void *anAddress)
Standard_EXPORT Visual3d_ContextView ()
 Creates a context from default values
.
Standard_EXPORT void SetSurfaceDetail (const Visual3d_TypeOfSurfaceDetail TOSD)
 Selects the kind of rendering
default to: TOSD_NONE
.
Standard_EXPORT void SetTextureEnv (const Handle(Graphic3d_TextureEnv)&ATexture)
 Sets the environment texture to use
no environment texture by default
.
Standard_EXPORT void SetAliasingOn ()
 Activates antialiasing.
Antialiasing can be activated on all the structures
in the view
.
Standard_EXPORT void SetAliasingOff ()
 Deactivates the antialiasing.
.
Standard_EXPORT 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.
.
Standard_EXPORT 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.
.
Standard_EXPORT 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>.
.
Standard_EXPORT void SetDepthCueingOff ()
 Deactivates the depth-cueing.
.
Standard_EXPORT void SetClipPlaneOn (const Handle(Visual3d_ClipPlane)&AClipPlane)
 Activates the clipping plane <aclipplane>
.
Standard_EXPORT void SetClipPlaneOff (const Handle(Visual3d_ClipPlane)&AClipPlane)
 Deactivates the clipping plane <aclipplane>
.
Standard_EXPORT void SetLightOn (const Handle(Visual3d_Light)&ALight)
 Activates the light source <alight>
.
Standard_EXPORT void SetLightOff (const Handle(Visual3d_Light)&ALight)
 Deactivates the light source <alight>
.
Standard_EXPORT void SetModel (const Visual3d_TypeOfModel AModel)
 Modifies the shading model when the type of
visualization is TOV_SHADING
.
Standard_EXPORT void SetVisualization (const Visual3d_TypeOfVisualization AVisual)
 Modifies the mode of visualization.
.
Standard_EXPORT 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.
.
Standard_EXPORT 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.
.
Standard_EXPORT 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>.
.
Standard_EXPORT void SetZClippingOff ()
 Deactivates the Z-clipping planes defined by
SetFrontPlane and SetBackPlane.
.
Standard_EXPORT void SetFrontZClippingOn ()
 Activates the front Z-clipping plane defined by
SetFrontPlane method.
.
Standard_EXPORT void SetFrontZClippingOff ()
 Deactivates the front Z-clipping plane defined by
SetFrontPlane method.
.
Standard_EXPORT 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>.
.
Standard_EXPORT void SetBackZClippingOff ()
 Deactivates the back Z-clipping plane defined by
SetBackPlane method.
.
Standard_EXPORT Handle_Visual3d_HSetOfClipPlane ActivatedClipPlanes () const
 Returns the group of active clipping planes
in the view of context <me>.
.
Standard_EXPORT Standard_Integer NumberOfActivatedClipPlanes () const
 Returns the number of active clipping planes
in the view of context <me>.
.
Standard_EXPORT Handle_Visual3d_ClipPlane ActivatedClipPlane (const Standard_Integer AnIndex) const
Standard_EXPORT Handle_Visual3d_HSetOfLight ActivatedLights () const
 Returns the group of active light sources
in the view of context <me>.
.
Standard_EXPORT Standard_Integer NumberOfActivatedLights () const
 Returns the number of active light sources
in the view of context <me>.
.
Standard_EXPORT Handle_Visual3d_Light ActivatedLight (const Standard_Integer AnIndex) const
Standard_EXPORT Standard_Boolean AliasingIsOn () const
 Returns the activity of the aliasing.
.
Standard_EXPORT Standard_Boolean BackZClippingIsOn () const
 Returns the activity of the ZClipping.
.
Standard_EXPORT Standard_Real DepthCueingBackPlane () const
 Returns the definition of the back depth-cueing plane.
.
Standard_EXPORT Standard_Real DepthCueingFrontPlane () const
 Returns the definition of the front depth-cueing plane.
.
Standard_EXPORT Standard_Boolean DepthCueingIsOn () const
 Returns the activity of the depth-cueing.
.
Standard_EXPORT Standard_Boolean FrontZClippingIsOn () const
 Returns the activity of the ZClipping.
.
Standard_EXPORT Visual3d_TypeOfModel Model () const
 Returns the shading model.
.
Standard_EXPORT Visual3d_TypeOfVisualization Visualization () const
 Returns the mode of visualization.
.
Standard_EXPORT Standard_Real ZClippingBackPlane () const
 Returns the definition of the back Z-clipping plane.
.
Standard_EXPORT Standard_Real ZClippingFrontPlane () const
 Returns the definition of the front Z-clipping plane.
.
Standard_EXPORT Visual3d_TypeOfSurfaceDetail SurfaceDetail () const
Standard_EXPORT Handle_Graphic3d_TextureEnv TextureEnv () const

Private Attributes

Standard_Boolean AliasingIsActive
Standard_Boolean ZcueingIsActive
Standard_Boolean FrontZclippingIsActive
Standard_Boolean BackZclippingIsActive
Standard_ShortReal MyZclippingFrontPlane
Standard_ShortReal MyZclippingBackPlane
Standard_ShortReal MyDepthCueingFrontPlane
Standard_ShortReal MyDepthCueingBackPlane
Visual3d_TypeOfModel MyModel
Visual3d_TypeOfVisualization MyVisual
Graphic3d_SequenceOfAddress MyLights
Graphic3d_SequenceOfAddress MyClipPlanes
Handle_Graphic3d_TextureEnv MyTextureEnv
Visual3d_TypeOfSurfaceDetail MySurfaceDetail


Constructor & Destructor Documentation

Standard_EXPORT Visual3d_ContextView::Visual3d_ContextView  ) 
 


Member Function Documentation

Standard_EXPORT Handle_Visual3d_ClipPlane Visual3d_ContextView::ActivatedClipPlane const Standard_Integer  AnIndex  )  const
 

Standard_EXPORT Handle_Visual3d_HSetOfClipPlane Visual3d_ContextView::ActivatedClipPlanes  )  const
 

Standard_EXPORT Handle_Visual3d_Light Visual3d_ContextView::ActivatedLight const Standard_Integer  AnIndex  )  const
 

Standard_EXPORT Handle_Visual3d_HSetOfLight Visual3d_ContextView::ActivatedLights  )  const
 

Standard_EXPORT Standard_Boolean Visual3d_ContextView::AliasingIsOn  )  const
 

Standard_EXPORT Standard_Boolean Visual3d_ContextView::BackZClippingIsOn  )  const
 

Standard_EXPORT Standard_Real Visual3d_ContextView::DepthCueingBackPlane  )  const
 

Standard_EXPORT Standard_Real Visual3d_ContextView::DepthCueingFrontPlane  )  const
 

Standard_EXPORT Standard_Boolean Visual3d_ContextView::DepthCueingIsOn  )  const
 

Standard_EXPORT Standard_Boolean Visual3d_ContextView::FrontZClippingIsOn  )  const
 

Standard_EXPORT Visual3d_TypeOfModel Visual3d_ContextView::Model  )  const
 

Standard_EXPORT Standard_Integer Visual3d_ContextView::NumberOfActivatedClipPlanes  )  const
 

Standard_EXPORT Standard_Integer Visual3d_ContextView::NumberOfActivatedLights  )  const
 

void Visual3d_ContextView::operator delete void *  anAddress  )  [inline]
 

void* Visual3d_ContextView::operator new size_t  size  )  [inline]
 

void* Visual3d_ContextView::operator new size_t  ,
void *  anAddress
[inline]
 

Standard_EXPORT void Visual3d_ContextView::SetAliasingOff  ) 
 

Standard_EXPORT void Visual3d_ContextView::SetAliasingOn  ) 
 

Standard_EXPORT void Visual3d_ContextView::SetBackZClippingOff  ) 
 

Standard_EXPORT void Visual3d_ContextView::SetBackZClippingOn  ) 
 

Standard_EXPORT void Visual3d_ContextView::SetClipPlaneOff const Handle(Visual3d_ClipPlane)&  AClipPlane  ) 
 

Standard_EXPORT void Visual3d_ContextView::SetClipPlaneOn const Handle(Visual3d_ClipPlane)&  AClipPlane  ) 
 

Standard_EXPORT void Visual3d_ContextView::SetDepthCueingBackPlane const Standard_Real  ABack  ) 
 

Standard_EXPORT void Visual3d_ContextView::SetDepthCueingFrontPlane const Standard_Real  ABack  ) 
 

Standard_EXPORT void Visual3d_ContextView::SetDepthCueingOff  ) 
 

Standard_EXPORT void Visual3d_ContextView::SetDepthCueingOn  ) 
 

Standard_EXPORT void Visual3d_ContextView::SetFrontZClippingOff  ) 
 

Standard_EXPORT void Visual3d_ContextView::SetFrontZClippingOn  ) 
 

Standard_EXPORT void Visual3d_ContextView::SetLightOff const Handle(Visual3d_Light)&  ALight  ) 
 

Standard_EXPORT void Visual3d_ContextView::SetLightOn const Handle(Visual3d_Light)&  ALight  ) 
 

Standard_EXPORT void Visual3d_ContextView::SetModel const Visual3d_TypeOfModel  AModel  ) 
 

Standard_EXPORT void Visual3d_ContextView::SetSurfaceDetail const Visual3d_TypeOfSurfaceDetail  TOSD  ) 
 

Standard_EXPORT void Visual3d_ContextView::SetTextureEnv const Handle(Graphic3d_TextureEnv)&  ATexture  ) 
 

Standard_EXPORT void Visual3d_ContextView::SetVisualization const Visual3d_TypeOfVisualization  AVisual  ) 
 

Standard_EXPORT void Visual3d_ContextView::SetZClippingBackPlane const Standard_Real  ABack  ) 
 

Standard_EXPORT void Visual3d_ContextView::SetZClippingFrontPlane const Standard_Real  AFront  ) 
 

Standard_EXPORT void Visual3d_ContextView::SetZClippingOff  ) 
 

Standard_EXPORT void Visual3d_ContextView::SetZClippingOn  ) 
 

Standard_EXPORT Visual3d_TypeOfSurfaceDetail Visual3d_ContextView::SurfaceDetail  )  const
 

Standard_EXPORT Handle_Graphic3d_TextureEnv Visual3d_ContextView::TextureEnv  )  const
 

Standard_EXPORT Visual3d_TypeOfVisualization Visual3d_ContextView::Visualization  )  const
 

Standard_EXPORT Standard_Real Visual3d_ContextView::ZClippingBackPlane  )  const
 

Standard_EXPORT Standard_Real Visual3d_ContextView::ZClippingFrontPlane  )  const
 


Field Documentation

Standard_Boolean Visual3d_ContextView::AliasingIsActive [private]
 

Standard_Boolean Visual3d_ContextView::BackZclippingIsActive [private]
 

Standard_Boolean Visual3d_ContextView::FrontZclippingIsActive [private]
 

Graphic3d_SequenceOfAddress Visual3d_ContextView::MyClipPlanes [private]
 

Standard_ShortReal Visual3d_ContextView::MyDepthCueingBackPlane [private]
 

Standard_ShortReal Visual3d_ContextView::MyDepthCueingFrontPlane [private]
 

Graphic3d_SequenceOfAddress Visual3d_ContextView::MyLights [private]
 

Visual3d_TypeOfModel Visual3d_ContextView::MyModel [private]
 

Visual3d_TypeOfSurfaceDetail Visual3d_ContextView::MySurfaceDetail [private]
 

Handle_Graphic3d_TextureEnv Visual3d_ContextView::MyTextureEnv [private]
 

Visual3d_TypeOfVisualization Visual3d_ContextView::MyVisual [private]
 

Standard_ShortReal Visual3d_ContextView::MyZclippingBackPlane [private]
 

Standard_ShortReal Visual3d_ContextView::MyZclippingFrontPlane [private]
 

Standard_Boolean Visual3d_ContextView::ZcueingIsActive [private]
 


The documentation for this class was generated from the following file:
Generated on Mon Aug 25 13:56:27 2008 for OpenCASCADE by  doxygen 1.4.1