// This file is generated by WOK (CPPExt). // Please do not edit this file; modify original file instead. // The copyright and license terms as defined for the original file apply to // this header file considered to be the "object code" form of the original source. #ifndef _Visual3d_ContextView_HeaderFile #define _Visual3d_ContextView_HeaderFile #ifndef _Standard_HeaderFile #include #endif #ifndef _Standard_Macro_HeaderFile #include #endif #ifndef _Standard_Boolean_HeaderFile #include #endif #ifndef _Standard_ShortReal_HeaderFile #include #endif #ifndef _Visual3d_TypeOfModel_HeaderFile #include #endif #ifndef _Visual3d_TypeOfVisualization_HeaderFile #include #endif #ifndef _TColStd_SequenceOfAddress_HeaderFile #include #endif #ifndef _Handle_Graphic3d_TextureEnv_HeaderFile #include #endif #ifndef _Visual3d_TypeOfSurfaceDetail_HeaderFile #include #endif #ifndef _Standard_Real_HeaderFile #include #endif #ifndef _Handle_Visual3d_ClipPlane_HeaderFile #include #endif #ifndef _Handle_Visual3d_Light_HeaderFile #include #endif #ifndef _Handle_Visual3d_HSetOfClipPlane_HeaderFile #include #endif #ifndef _Standard_Integer_HeaderFile #include #endif #ifndef _Handle_Visual3d_HSetOfLight_HeaderFile #include #endif class Graphic3d_TextureEnv; class Visual3d_ClipDefinitionError; class Visual3d_DepthCueingDefinitionError; class Visual3d_LightDefinitionError; class Visual3d_ZClippingDefinitionError; class Visual3d_ClipPlane; class Visual3d_Light; class Visual3d_HSetOfClipPlane; class Visual3d_HSetOfLight; //! 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.
class Visual3d_ContextView { public: void* operator new(size_t,void* anAddress) { return anAddress; } void* operator new(size_t size) { return Standard::Allocate(size); } void operator delete(void *anAddress) { if (anAddress) Standard::Free((Standard_Address&)anAddress); } //! Creates a context from default values
Standard_EXPORT Visual3d_ContextView(); //! Selects the kind of rendering
//! default to: TOSD_NONE
Standard_EXPORT void SetSurfaceDetail(const Visual3d_TypeOfSurfaceDetail TOSD) ; //! Sets the environment texture to use
//! no environment texture by default
Standard_EXPORT void SetTextureEnv(const Handle(Graphic3d_TextureEnv)& ATexture) ; //! Activates antialiasing.
//! Antialiasing can be activated on all the structures
//! in the view
Standard_EXPORT void SetAliasingOn() ; //! Deactivates the antialiasing.
Standard_EXPORT void SetAliasingOff() ; //! Modifies the back depth-cueing plane.
//! Category: Methods to modify the class definition
//! Warning: Raises DepthCueingDefinitionError if
//! is front of and DepthCueing is ON.
Standard_EXPORT void SetDepthCueingBackPlane(const Standard_Real ABack) ; //! Modifies the front depth-cueing plane.
//! Category: Methods to modify the class definition
//! Warning: Raises DepthCueingDefinitionError if is
//! front of and DepthCueing is ON.
Standard_EXPORT void SetDepthCueingFrontPlane(const Standard_Real ABack) ; //! 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 is
//! front of .
Standard_EXPORT void SetDepthCueingOn() ; //! Deactivates the depth-cueing.
Standard_EXPORT void SetDepthCueingOff() ; //! Activates the clipping plane
Standard_EXPORT void SetClipPlaneOn(const Handle(Visual3d_ClipPlane)& AClipPlane) ; //! Deactivates the clipping plane
Standard_EXPORT void SetClipPlaneOff(const Handle(Visual3d_ClipPlane)& AClipPlane) ; //! Activates the light source
Standard_EXPORT void SetLightOn(const Handle(Visual3d_Light)& ALight) ; //! Deactivates the light source
Standard_EXPORT void SetLightOff(const Handle(Visual3d_Light)& ALight) ; //! Modifies the shading model when the type of
//! visualization is TOV_SHADING
Standard_EXPORT void SetModel(const Visual3d_TypeOfModel AModel) ; //! Modifies the mode of visualization.
Standard_EXPORT void SetVisualization(const Visual3d_TypeOfVisualization AVisual) ; //! Modifies the back Z-clipping plane.
//! Category: Methods to modify the class definition
//! Warning: Raises ZClippingDefinitionError if is
//! front of and ZClipping is ON.
Standard_EXPORT void SetZClippingBackPlane(const Standard_Real ABack) ; //! Modifies the front Z-clipping plane.
//! Category: Methods to modify the class definition
//! Warning: Raises ZClippingDefinitionError if is
//! front of and ZClipping is ON.
Standard_EXPORT void SetZClippingFrontPlane(const Standard_Real AFront) ; //! Activates the Z-clipping planes defined by
//! SetZClippingFrontPlane and SetZClippingBackPlane.
//! Category: Methods to modify the class definition
//! Warning: Raises ZClippingDefinitionError if is
//! front of .
Standard_EXPORT void SetZClippingOn() ; //! Deactivates the Z-clipping planes defined by
//! SetFrontPlane and SetBackPlane.
Standard_EXPORT void SetZClippingOff() ; //! Activates the front Z-clipping plane defined by
//! SetFrontPlane method.
Standard_EXPORT void SetFrontZClippingOn() ; //! Deactivates the front Z-clipping plane defined by
//! SetFrontPlane method.
Standard_EXPORT void SetFrontZClippingOff() ; //! Activates the back Z-clipping plane defined by
//! SetBackPlane method.
//! Category: Methods to modify the class definition
//! Warning: Raises ZClippingDefinitionError if is
//! front of .
Standard_EXPORT void SetBackZClippingOn() ; //! Deactivates the back Z-clipping plane defined by
//! SetBackPlane method.
Standard_EXPORT void SetBackZClippingOff() ; //! Returns the group of active clipping planes
//! in the view of context .
Standard_EXPORT Handle_Visual3d_HSetOfClipPlane ActivatedClipPlanes() const; //! Returns the number of active clipping planes
//! in the view of context .
Standard_EXPORT Standard_Integer NumberOfActivatedClipPlanes() const; Standard_EXPORT Handle_Visual3d_ClipPlane ActivatedClipPlane(const Standard_Integer AnIndex) const; //! Returns the group of active light sources
//! in the view of context .
Standard_EXPORT Handle_Visual3d_HSetOfLight ActivatedLights() const; //! Returns the number of active light sources
//! in the view of context .
Standard_EXPORT Standard_Integer NumberOfActivatedLights() const; Standard_EXPORT Handle_Visual3d_Light ActivatedLight(const Standard_Integer AnIndex) const; //! Returns the activity of the aliasing.
Standard_EXPORT Standard_Boolean AliasingIsOn() const; //! Returns the activity of the ZClipping.
Standard_EXPORT Standard_Boolean BackZClippingIsOn() const; //! Returns the definition of the back depth-cueing plane.
Standard_EXPORT Standard_Real DepthCueingBackPlane() const; //! Returns the definition of the front depth-cueing plane.
Standard_EXPORT Standard_Real DepthCueingFrontPlane() const; //! Returns the activity of the depth-cueing.
Standard_EXPORT Standard_Boolean DepthCueingIsOn() const; //! Returns the activity of the ZClipping.
Standard_EXPORT Standard_Boolean FrontZClippingIsOn() const; //! Returns the shading model.
Standard_EXPORT Visual3d_TypeOfModel Model() const; //! Returns the mode of visualization.
Standard_EXPORT Visual3d_TypeOfVisualization Visualization() const; //! Returns the definition of the back Z-clipping plane.
Standard_EXPORT Standard_Real ZClippingBackPlane() const; //! Returns the definition of the front Z-clipping plane.
Standard_EXPORT Standard_Real ZClippingFrontPlane() const; Standard_EXPORT Visual3d_TypeOfSurfaceDetail SurfaceDetail() const; Standard_EXPORT Handle_Graphic3d_TextureEnv TextureEnv() const; protected: private: 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; TColStd_SequenceOfAddress MyLights; TColStd_SequenceOfAddress MyClipPlanes; Handle_Graphic3d_TextureEnv MyTextureEnv; Visual3d_TypeOfSurfaceDetail MySurfaceDetail; }; // other Inline functions and methods (like "C++: function call" methods) #endif