|
Open CASCADE Technology
6.9.0
|
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. More...
#include <Visual3d_ContextView.hxx>
Public Member Functions | |
| Visual3d_ContextView () | |
| Creates a context from default values. More... | |
| void | SetSurfaceDetail (const Visual3d_TypeOfSurfaceDetail TOSD) |
| Selects the kind of rendering default to: TOSD_NONE. More... | |
| void | SetTextureEnv (const Handle< Graphic3d_TextureEnv > &ATexture) |
| Sets the environment texture to use no environment texture by default. More... | |
| void | SetAliasingOn () |
| Activates antialiasing. Antialiasing can be activated on all the structures in the view. More... | |
| void | SetAliasingOff () |
| Deactivates the antialiasing. More... | |
| 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. More... | |
| 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. More... | |
| 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>. More... | |
| void | SetDepthCueingOff () |
| Deactivates the depth-cueing. More... | |
| const Graphic3d_SequenceOfHClipPlane & | ClipPlanes () const |
| Returns sequence of clip planes. More... | |
| Graphic3d_SequenceOfHClipPlane & | ChangeClipPlanes () |
| Change clip planes. More... | |
| void | SetLightOn (const Handle< Visual3d_Light > &ALight) |
| Activates the light source <ALight> More... | |
| void | SetLightOff (const Handle< Visual3d_Light > &ALight) |
| Deactivates the light source <ALight> More... | |
| void | SetModel (const Visual3d_TypeOfModel AModel) |
| Modifies the shading model when the type of visualization is TOV_SHADING. More... | |
| void | SetVisualization (const Visual3d_TypeOfVisualization AVisual) |
| Modifies the mode of visualization. More... | |
| 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. More... | |
| 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. More... | |
| 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>. More... | |
| void | SetZClippingOff () |
| Deactivates the Z-clipping planes defined by SetFrontPlane and SetBackPlane. More... | |
| void | SetFrontZClippingOn () |
| Activates the front Z-clipping plane defined by SetFrontPlane method. More... | |
| void | SetFrontZClippingOff () |
| Deactivates the front Z-clipping plane defined by SetFrontPlane method. More... | |
| 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>. More... | |
| void | SetBackZClippingOff () |
| Deactivates the back Z-clipping plane defined by SetBackPlane method. More... | |
| Handle< Visual3d_HSequenceOfLight > | ActivatedLights () const |
| Returns the group of active light sources in the view of context <me>. More... | |
| Standard_Integer | NumberOfActivatedLights () const |
| Returns the number of active light sources in the view of context <me>. More... | |
| Handle< Visual3d_Light > | ActivatedLight (const Standard_Integer AnIndex) const |
| Standard_Boolean | AliasingIsOn () const |
| Returns the activity of the aliasing. More... | |
| Standard_Boolean | BackZClippingIsOn () const |
| Returns the activity of the ZClipping. More... | |
| Standard_Real | DepthCueingBackPlane () const |
| Returns the definition of the back depth-cueing plane. More... | |
| Standard_Real | DepthCueingFrontPlane () const |
| Returns the definition of the front depth-cueing plane. More... | |
| Standard_Boolean | DepthCueingIsOn () const |
| Returns the activity of the depth-cueing. More... | |
| Standard_Boolean | FrontZClippingIsOn () const |
| Returns the activity of the ZClipping. More... | |
| Visual3d_TypeOfModel | Model () const |
| Returns the shading model. More... | |
| Visual3d_TypeOfVisualization | Visualization () const |
| Returns the mode of visualization. More... | |
| Standard_Real | ZClippingBackPlane () const |
| Returns the definition of the back Z-clipping plane. More... | |
| Standard_Real | ZClippingFrontPlane () const |
| Returns the definition of the front Z-clipping plane. More... | |
| Visual3d_TypeOfSurfaceDetail | SurfaceDetail () const |
| Handle< Graphic3d_TextureEnv > | TextureEnv () const |
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.
| Visual3d_ContextView::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
| Handle< Visual3d_Light > Visual3d_ContextView::ActivatedLight | ( | const Standard_Integer | AnIndex | ) | const |
| Handle< Visual3d_HSequenceOfLight > Visual3d_ContextView::ActivatedLights | ( | ) | const |
Returns the group of active light sources in the view of context <me>.
| Standard_Boolean Visual3d_ContextView::AliasingIsOn | ( | ) | const |
Returns the activity of the aliasing.
| Standard_Boolean Visual3d_ContextView::BackZClippingIsOn | ( | ) | const |
Returns the activity of the ZClipping.
| Graphic3d_SequenceOfHClipPlane& Visual3d_ContextView::ChangeClipPlanes | ( | ) |
Change clip planes.
| const Graphic3d_SequenceOfHClipPlane& Visual3d_ContextView::ClipPlanes | ( | ) | const |
Returns sequence of clip planes.
| Standard_Real Visual3d_ContextView::DepthCueingBackPlane | ( | ) | const |
Returns the definition of the back depth-cueing plane.
| Standard_Real Visual3d_ContextView::DepthCueingFrontPlane | ( | ) | const |
Returns the definition of the front depth-cueing plane.
| Standard_Boolean Visual3d_ContextView::DepthCueingIsOn | ( | ) | const |
Returns the activity of the depth-cueing.
| Standard_Boolean Visual3d_ContextView::FrontZClippingIsOn | ( | ) | const |
Returns the activity of the ZClipping.
| Visual3d_TypeOfModel Visual3d_ContextView::Model | ( | ) | const |
Returns the shading model.
| Standard_Integer Visual3d_ContextView::NumberOfActivatedLights | ( | ) | const |
Returns the number of active light sources in the view of context <me>.
| void Visual3d_ContextView::SetAliasingOff | ( | ) |
Deactivates the antialiasing.
| void Visual3d_ContextView::SetAliasingOn | ( | ) |
Activates antialiasing. Antialiasing can be activated on all the structures in the view.
| void Visual3d_ContextView::SetBackZClippingOff | ( | ) |
Deactivates the back Z-clipping plane defined by SetBackPlane method.
| void Visual3d_ContextView::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 Visual3d_ContextView::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 Visual3d_ContextView::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 Visual3d_ContextView::SetDepthCueingOff | ( | ) |
Deactivates the depth-cueing.
| void Visual3d_ContextView::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 Visual3d_ContextView::SetFrontZClippingOff | ( | ) |
Deactivates the front Z-clipping plane defined by SetFrontPlane method.
| void Visual3d_ContextView::SetFrontZClippingOn | ( | ) |
Activates the front Z-clipping plane defined by SetFrontPlane method.
| void Visual3d_ContextView::SetLightOff | ( | const Handle< Visual3d_Light > & | ALight | ) |
Deactivates the light source <ALight>
| void Visual3d_ContextView::SetLightOn | ( | const Handle< Visual3d_Light > & | ALight | ) |
Activates the light source <ALight>
| void Visual3d_ContextView::SetModel | ( | const Visual3d_TypeOfModel | AModel | ) |
Modifies the shading model when the type of visualization is TOV_SHADING.
| void Visual3d_ContextView::SetSurfaceDetail | ( | const Visual3d_TypeOfSurfaceDetail | TOSD | ) |
Selects the kind of rendering default to: TOSD_NONE.
| void Visual3d_ContextView::SetTextureEnv | ( | const Handle< Graphic3d_TextureEnv > & | ATexture | ) |
Sets the environment texture to use no environment texture by default.
| void Visual3d_ContextView::SetVisualization | ( | const Visual3d_TypeOfVisualization | AVisual | ) |
Modifies the mode of visualization.
TypeOfVisualization : TOV_WIREFRAME TOV_SHADING
| void Visual3d_ContextView::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 Visual3d_ContextView::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 Visual3d_ContextView::SetZClippingOff | ( | ) |
Deactivates the Z-clipping planes defined by SetFrontPlane and SetBackPlane.
| void Visual3d_ContextView::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>.
| Visual3d_TypeOfSurfaceDetail Visual3d_ContextView::SurfaceDetail | ( | ) | const |
| Handle< Graphic3d_TextureEnv > Visual3d_ContextView::TextureEnv | ( | ) | const |
| Visual3d_TypeOfVisualization Visual3d_ContextView::Visualization | ( | ) | const |
Returns the mode of visualization.
| Standard_Real Visual3d_ContextView::ZClippingBackPlane | ( | ) | const |
Returns the definition of the back Z-clipping plane.
| Standard_Real Visual3d_ContextView::ZClippingFrontPlane | ( | ) | const |
Returns the definition of the front Z-clipping plane.
1.8.5