Open CASCADE Technology  7.3.1.dev
Public Member Functions | Protected Attributes
Graphic3d_CView Class Referenceabstract

Base class of a graphical view that carries out rendering process for a concrete implementation of graphical driver. Provides virtual interfaces for redrawing its contents, management of displayed structures and render settings. The source code of the class itself implements functionality related to management of computed (HLR or "view-dependent") structures. More...

#include <Graphic3d_CView.hxx>

Inheritance diagram for Graphic3d_CView:
Inheritance graph
[legend]

Public Member Functions

 Graphic3d_CView (const Handle< Graphic3d_StructureManager > &theMgr)
 Constructor. More...
 
virtual ~Graphic3d_CView ()
 Destructor. More...
 
Standard_Integer Identification () const
 Returns the identification number of the view. More...
 
virtual void Activate ()
 Activates the view. Maps presentations defined within structure manager onto this view. More...
 
virtual void Deactivate ()
 Deactivates the view. Unmaps presentations defined within structure manager. The view in deactivated state will ignore actions on structures such as Display(). More...
 
Standard_Boolean IsActive () const
 Returns the activity flag of the view. More...
 
virtual void Remove ()
 Erases the view and removes from graphic driver. No more graphic operations are allowed in this view after the call. More...
 
Standard_Boolean IsRemoved () const
 Returns true if the view was removed. More...
 
Graphic3d_TypeOfShadingModel ShadingModel () const
 Returns default Shading Model of the view; Graphic3d_TOSM_FRAGMENT by default. More...
 
void SetShadingModel (Graphic3d_TypeOfShadingModel theModel)
 Sets default Shading Model of the view. Will throw an exception on attempt to set Graphic3d_TOSM_DEFAULT. More...
 
Graphic3d_TypeOfVisualization VisualizationType () const
 Returns visualization type of the view. More...
 
void SetVisualizationType (const Graphic3d_TypeOfVisualization theType)
 Sets visualization type of the view. More...
 
void SetComputedMode (const Standard_Boolean theMode)
 Switches computed HLR mode in the view. More...
 
Standard_Boolean ComputedMode () const
 Returns the computed HLR mode state. More...
 
void ReCompute (const Handle< Graphic3d_Structure > &theStructure)
 Computes the new presentation of the structure displayed in this view with the type Graphic3d_TOS_COMPUTED. More...
 
void Update (const Graphic3d_ZLayerId theLayerId=Graphic3d_ZLayerId_UNKNOWN)
 Invalidates bounding box of specified ZLayerId. More...
 
void Compute ()
 Computes the new presentation of the structures displayed in this view with the type Graphic3d_TOS_COMPUTED. More...
 
Standard_Boolean ContainsFacet () const
 Returns Standard_True if one of the structures displayed in the view contains Polygons, Triangles or Quadrangles. More...
 
Standard_Boolean ContainsFacet (const Graphic3d_MapOfStructure &theSet) const
 Returns Standard_True if one of the structures in the set contains Polygons, Triangles or Quadrangles. More...
 
void DisplayedStructures (Graphic3d_MapOfStructure &theStructures) const
 Returns the set of structures displayed in this view. More...
 
virtual Standard_Integer NumberOfDisplayedStructures () const
 Returns number of displayed structures in the view. More...
 
const Handle< Graphic3d_NMapOfTransient > & HiddenObjects () const
 Returns map of objects hidden within this specific view (not viewer-wise). More...
 
Handle< Graphic3d_NMapOfTransient > & ChangeHiddenObjects ()
 Returns map of objects hidden within this specific view (not viewer-wise). More...
 
Standard_Boolean IsComputed (const Standard_Integer theStructId, Handle< Graphic3d_Structure > &theComputedStruct) const
 Returns Standard_True in case if the structure with the given <theStructId> is in list of structures to be computed and stores computed struct to <theComputedStruct>. More...
 
virtual Bnd_Box MinMaxValues (const Standard_Boolean theToIncludeAuxiliary=Standard_False) const
 Returns the bounding box of all structures displayed in the view. If theToIncludeAuxiliary is TRUE, then the boundary box also includes minimum and maximum limits of graphical elements forming parts of infinite and other auxiliary structures. More...
 
Bnd_Box MinMaxValues (const Graphic3d_MapOfStructure &theSet, const Standard_Boolean theToIncludeAuxiliary=Standard_False) const
 Returns the coordinates of the boundary box of all structures in the set <theSet>. If <theToIgnoreInfiniteFlag> is TRUE, then the boundary box also includes minimum and maximum limits of graphical elements forming parts of infinite structures. More...
 
const Handle< Graphic3d_StructureManager > & StructureManager () const
 Returns the structure manager handle which manage structures associated with this view. More...
 
virtual void Redraw ()=0
 Redraw content of the view. More...
 
virtual void RedrawImmediate ()=0
 Redraw immediate content of the view. More...
 
virtual void Invalidate ()=0
 Invalidates content of the view but does not redraw it. More...
 
virtual Standard_Boolean IsInvalidated ()=0
 Return true if view content cache has been invalidated. More...
 
virtual void Resized ()=0
 Handle changing size of the rendering window. More...
 
virtual Standard_Boolean SetImmediateModeDrawToFront (const Standard_Boolean theDrawToFrontBuffer)=0
 
virtual void SetWindow (const Handle< Aspect_Window > &theWindow, const Aspect_RenderingContext theContext=NULL)=0
 Creates and maps rendering window to the view. More...
 
virtual Handle< Aspect_WindowWindow () const =0
 Returns the window associated to the view. More...
 
virtual Standard_Boolean IsDefined () const =0
 Returns True if the window associated to the view is defined. More...
 
virtual const Graphic3d_GraduatedTrihedronGetGraduatedTrihedron ()=0
 Returns data of a graduated trihedron. More...
 
virtual void GraduatedTrihedronDisplay (const Graphic3d_GraduatedTrihedron &theTrihedronData)=0
 Displays Graduated Trihedron. More...
 
virtual void GraduatedTrihedronErase ()=0
 Erases Graduated Trihedron. More...
 
virtual void GraduatedTrihedronMinMaxValues (const Graphic3d_Vec3 theMin, const Graphic3d_Vec3 theMax)=0
 Sets minimum and maximum points of scene bounding box for Graduated Trihedron stored in graphic view object. More...
 
virtual Standard_Boolean BufferDump (Image_PixMap &theImage, const Graphic3d_BufferType &theBufferType)=0
 Dump active rendering buffer into specified memory buffer. More...
 
virtual void InvalidateBVHData (const Graphic3d_ZLayerId theLayerId)=0
 Marks BVH tree and the set of BVH primitives of correspondent priority list with id theLayerId as outdated. More...
 
virtual void AddZLayer (const Graphic3d_ZLayerId theLayerId)=0
 Add a new top-level z layer with ID <theLayerId> for the view. Z layers allow drawing structures in higher layers in foreground of structures in lower layers. To add a structure to desired layer on display it is necessary to set the layer ID for the structure. More...
 
virtual Standard_Integer ZLayerMax () const =0
 Returns the maximum Z layer ID. First layer ID is Graphic3d_ZLayerId_Default, last ID is ZLayerMax(). More...
 
virtual void InvalidateZLayerBoundingBox (const Graphic3d_ZLayerId theLayerId) const =0
 Returns the bounding box of all structures displayed in the Z layer. More...
 
virtual Bnd_Box ZLayerBoundingBox (const Graphic3d_ZLayerId theLayerId, const Handle< Graphic3d_Camera > &theCamera, const Standard_Integer theWindowWidth, const Standard_Integer theWindowHeight, const Standard_Boolean theToIncludeAuxiliary) const =0
 Returns the bounding box of all structures displayed in the Z layer. More...
 
virtual void RemoveZLayer (const Graphic3d_ZLayerId theLayerId)=0
 Remove Z layer from the specified view. All structures displayed at the moment in layer will be displayed in default layer ( the bottom-level z layer ). To unset layer ID from associated structures use method UnsetZLayer (...). More...
 
virtual void SetZLayerSettings (const Graphic3d_ZLayerId theLayerId, const Graphic3d_ZLayerSettings &theSettings)=0
 Sets the settings for a single Z layer of specified view. More...
 
Standard_Real ConsiderZoomPersistenceObjects ()
 Returns zoom-scale factor. More...
 
virtual Handle< Standard_TransientFBO () const =0
 Returns pointer to an assigned framebuffer object. More...
 
virtual void SetFBO (const Handle< Standard_Transient > &theFbo)=0
 Sets framebuffer object for offscreen rendering. More...
 
virtual Handle< Standard_TransientFBOCreate (const Standard_Integer theWidth, const Standard_Integer theHeight)=0
 Generate offscreen FBO in the graphic library. If not supported on hardware returns NULL. More...
 
virtual void FBORelease (Handle< Standard_Transient > &theFbo)=0
 Remove offscreen FBO from the graphic library. More...
 
virtual void FBOGetDimensions (const Handle< Standard_Transient > &theFbo, Standard_Integer &theWidth, Standard_Integer &theHeight, Standard_Integer &theWidthMax, Standard_Integer &theHeightMax)=0
 Read offscreen FBO configuration. More...
 
virtual void FBOChangeViewport (const Handle< Standard_Transient > &theFbo, const Standard_Integer theWidth, const Standard_Integer theHeight)=0
 Change offscreen FBO viewport. More...
 
virtual void CopySettings (const Handle< Graphic3d_CView > &theOther)
 Copy visualization settings from another view. Method is used for cloning views in viewer when its required to create view with same view properties. More...
 
const Graphic3d_RenderingParamsRenderingParams () const
 Returns current rendering parameters and effect settings. More...
 
Graphic3d_RenderingParamsChangeRenderingParams ()
 Returns reference to current rendering parameters and effect settings. More...
 
virtual Aspect_Background Background () const =0
 Returns background fill color. More...
 
virtual void SetBackground (const Aspect_Background &theBackground)=0
 Sets background fill color. More...
 
virtual Aspect_GradientBackground GradientBackground () const =0
 Returns gradient background fill colors. More...
 
virtual void SetGradientBackground (const Aspect_GradientBackground &theBackground)=0
 Sets gradient background fill colors. More...
 
virtual TCollection_AsciiString BackgroundImage ()=0
 Returns background image texture file path. More...
 
virtual void SetBackgroundImage (const TCollection_AsciiString &theFilePath)=0
 Sets background image texture file path. More...
 
virtual Aspect_FillMethod BackgroundImageStyle () const =0
 Returns background image fill style. More...
 
virtual void SetBackgroundImageStyle (const Aspect_FillMethod theFillStyle)=0
 Sets background image fill style. More...
 
virtual Handle< Graphic3d_TextureEnvTextureEnv () const =0
 Returns environment texture set for the view. More...
 
virtual void SetTextureEnv (const Handle< Graphic3d_TextureEnv > &theTextureEnv)=0
 Sets environment texture for the view. More...
 
virtual Graphic3d_TypeOfBackfacingModel BackfacingModel () const =0
 Return backfacing model used for the view. More...
 
virtual void SetBackfacingModel (const Graphic3d_TypeOfBackfacingModel theModel)=0
 Sets backfacing model for the view. More...
 
virtual const Handle< Graphic3d_Camera > & Camera () const =0
 Returns camera object of the view. More...
 
virtual void SetCamera (const Handle< Graphic3d_Camera > &theCamera)=0
 Sets camera used by the view. More...
 
virtual const Handle< Graphic3d_LightSet > & Lights () const =0
 Returns list of lights of the view. More...
 
virtual void SetLights (const Handle< Graphic3d_LightSet > &theLights)=0
 Sets list of lights for the view. More...
 
virtual const Handle< Graphic3d_SequenceOfHClipPlane > & ClipPlanes () const =0
 Returns list of clip planes set for the view. More...
 
virtual void SetClipPlanes (const Handle< Graphic3d_SequenceOfHClipPlane > &thePlanes)=0
 Sets list of clip planes for the view. More...
 
virtual void DiagnosticInformation (TColStd_IndexedDataMapOfStringString &theDict, Graphic3d_DiagnosticInfo theFlags) const =0
 Fill in the dictionary with diagnostic info. Should be called within rendering thread. More...
 
virtual TCollection_AsciiString StatisticInformation () const =0
 Returns string with statistic performance info. More...
 
virtual void StatisticInformation (TColStd_IndexedDataMapOfStringString &theDict) const =0
 Fills in the dictionary with statistic performance info. More...
 
- Public Member Functions inherited from Standard_Transient
 Standard_Transient ()
 Empty constructor. More...
 
 Standard_Transient (const Standard_Transient &)
 Copy constructor – does nothing. More...
 
Standard_Transientoperator= (const Standard_Transient &)
 Assignment operator, needed to avoid copying reference counter. More...
 
virtual ~Standard_Transient ()
 Destructor must be virtual. More...
 
virtual void Delete () const
 Memory deallocator for transient classes. More...
 
virtual const opencascade::handle< Standard_Type > & DynamicType () const
 Returns a type descriptor about this object. More...
 
Standard_Boolean IsInstance (const opencascade::handle< Standard_Type > &theType) const
 Returns a true value if this is an instance of Type. More...
 
Standard_Boolean IsInstance (const Standard_CString theTypeName) const
 Returns a true value if this is an instance of TypeName. More...
 
Standard_Boolean IsKind (const opencascade::handle< Standard_Type > &theType) const
 Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism. More...
 
Standard_Boolean IsKind (const Standard_CString theTypeName) const
 Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism. More...
 
Standard_TransientThis () const
 Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero. More...
 
Standard_Integer GetRefCount () const
 Get the reference counter of this object. More...
 
void IncrementRefCounter () const
 Increments the reference counter of this object. More...
 
Standard_Integer DecrementRefCounter () const
 Decrements the reference counter of this object; returns the decremented value. More...
 

Protected Attributes

Standard_Integer myId
 
Graphic3d_RenderingParams myRenderParams
 
Handle< Graphic3d_StructureManagermyStructureManager
 
Graphic3d_SequenceOfStructure myStructsToCompute
 
Graphic3d_SequenceOfStructure myStructsComputed
 
Graphic3d_MapOfStructure myStructsDisplayed
 
Handle< Graphic3d_NMapOfTransientmyHiddenObjects
 
Standard_Boolean myIsInComputedMode
 
Standard_Boolean myIsActive
 
Standard_Boolean myIsRemoved
 
Graphic3d_TypeOfShadingModel myShadingModel
 
Graphic3d_TypeOfVisualization myVisualization
 

Additional Inherited Members

- Public Types inherited from Standard_Transient
typedef void base_type
 Returns a type descriptor about this object. More...
 
- Static Public Member Functions inherited from Standard_Transient
static const char * get_type_name ()
 Returns a type descriptor about this object. More...
 
static const opencascade::handle< Standard_Type > & get_type_descriptor ()
 Returns type descriptor of Standard_Transient class. More...
 
- Protected Member Functions inherited from Graphic3d_DataStructureManager
 Graphic3d_DataStructureManager ()
 Initializes the manager <me>. More...
 

Detailed Description

Base class of a graphical view that carries out rendering process for a concrete implementation of graphical driver. Provides virtual interfaces for redrawing its contents, management of displayed structures and render settings. The source code of the class itself implements functionality related to management of computed (HLR or "view-dependent") structures.

Constructor & Destructor Documentation

◆ Graphic3d_CView()

Graphic3d_CView::Graphic3d_CView ( const Handle< Graphic3d_StructureManager > &  theMgr)

Constructor.

◆ ~Graphic3d_CView()

virtual Graphic3d_CView::~Graphic3d_CView ( )
virtual

Destructor.

Member Function Documentation

◆ Activate()

virtual void Graphic3d_CView::Activate ( )
virtual

Activates the view. Maps presentations defined within structure manager onto this view.

◆ AddZLayer()

virtual void Graphic3d_CView::AddZLayer ( const Graphic3d_ZLayerId  theLayerId)
pure virtual

Add a new top-level z layer with ID <theLayerId> for the view. Z layers allow drawing structures in higher layers in foreground of structures in lower layers. To add a structure to desired layer on display it is necessary to set the layer ID for the structure.

Implemented in OpenGl_View.

◆ BackfacingModel()

virtual Graphic3d_TypeOfBackfacingModel Graphic3d_CView::BackfacingModel ( ) const
pure virtual

Return backfacing model used for the view.

Implemented in OpenGl_View.

◆ Background()

virtual Aspect_Background Graphic3d_CView::Background ( ) const
pure virtual

Returns background fill color.

Implemented in OpenGl_View.

◆ BackgroundImage()

virtual TCollection_AsciiString Graphic3d_CView::BackgroundImage ( )
pure virtual

Returns background image texture file path.

Implemented in OpenGl_View.

◆ BackgroundImageStyle()

virtual Aspect_FillMethod Graphic3d_CView::BackgroundImageStyle ( ) const
pure virtual

Returns background image fill style.

Implemented in OpenGl_View.

◆ BufferDump()

virtual Standard_Boolean Graphic3d_CView::BufferDump ( Image_PixMap theImage,
const Graphic3d_BufferType theBufferType 
)
pure virtual

Dump active rendering buffer into specified memory buffer.

Implemented in OpenGl_View.

◆ Camera()

virtual const Handle< Graphic3d_Camera >& Graphic3d_CView::Camera ( ) const
pure virtual

Returns camera object of the view.

Implemented in OpenGl_View.

◆ ChangeHiddenObjects()

Handle< Graphic3d_NMapOfTransient >& Graphic3d_CView::ChangeHiddenObjects ( )
inline

Returns map of objects hidden within this specific view (not viewer-wise).

◆ ChangeRenderingParams()

Graphic3d_RenderingParams& Graphic3d_CView::ChangeRenderingParams ( )
inline

Returns reference to current rendering parameters and effect settings.

◆ ClipPlanes()

virtual const Handle< Graphic3d_SequenceOfHClipPlane >& Graphic3d_CView::ClipPlanes ( ) const
pure virtual

Returns list of clip planes set for the view.

Implemented in OpenGl_View.

◆ Compute()

void Graphic3d_CView::Compute ( )

Computes the new presentation of the structures displayed in this view with the type Graphic3d_TOS_COMPUTED.

◆ ComputedMode()

Standard_Boolean Graphic3d_CView::ComputedMode ( ) const
inline

Returns the computed HLR mode state.

◆ ConsiderZoomPersistenceObjects()

Standard_Real Graphic3d_CView::ConsiderZoomPersistenceObjects ( )

Returns zoom-scale factor.

◆ ContainsFacet() [1/2]

Standard_Boolean Graphic3d_CView::ContainsFacet ( ) const

Returns Standard_True if one of the structures displayed in the view contains Polygons, Triangles or Quadrangles.

◆ ContainsFacet() [2/2]

Standard_Boolean Graphic3d_CView::ContainsFacet ( const Graphic3d_MapOfStructure theSet) const

Returns Standard_True if one of the structures in the set contains Polygons, Triangles or Quadrangles.

◆ CopySettings()

virtual void Graphic3d_CView::CopySettings ( const Handle< Graphic3d_CView > &  theOther)
virtual

Copy visualization settings from another view. Method is used for cloning views in viewer when its required to create view with same view properties.

◆ Deactivate()

virtual void Graphic3d_CView::Deactivate ( )
virtual

Deactivates the view. Unmaps presentations defined within structure manager. The view in deactivated state will ignore actions on structures such as Display().

◆ DiagnosticInformation()

virtual void Graphic3d_CView::DiagnosticInformation ( TColStd_IndexedDataMapOfStringString theDict,
Graphic3d_DiagnosticInfo  theFlags 
) const
pure virtual

Fill in the dictionary with diagnostic info. Should be called within rendering thread.

This API should be used only for user output or for creating automated reports. The format of returned information (e.g. key-value layout) is NOT part of this API and can be changed at any time. Thus application should not parse returned information to weed out specific parameters.

Implemented in OpenGl_View.

◆ DisplayedStructures()

void Graphic3d_CView::DisplayedStructures ( Graphic3d_MapOfStructure theStructures) const

Returns the set of structures displayed in this view.

◆ FBO()

virtual Handle< Standard_Transient > Graphic3d_CView::FBO ( ) const
pure virtual

Returns pointer to an assigned framebuffer object.

Implemented in OpenGl_View.

◆ FBOChangeViewport()

virtual void Graphic3d_CView::FBOChangeViewport ( const Handle< Standard_Transient > &  theFbo,
const Standard_Integer  theWidth,
const Standard_Integer  theHeight 
)
pure virtual

Change offscreen FBO viewport.

Implemented in OpenGl_View.

◆ FBOCreate()

virtual Handle< Standard_Transient > Graphic3d_CView::FBOCreate ( const Standard_Integer  theWidth,
const Standard_Integer  theHeight 
)
pure virtual

Generate offscreen FBO in the graphic library. If not supported on hardware returns NULL.

Implemented in OpenGl_View.

◆ FBOGetDimensions()

virtual void Graphic3d_CView::FBOGetDimensions ( const Handle< Standard_Transient > &  theFbo,
Standard_Integer theWidth,
Standard_Integer theHeight,
Standard_Integer theWidthMax,
Standard_Integer theHeightMax 
)
pure virtual

Read offscreen FBO configuration.

Implemented in OpenGl_View.

◆ FBORelease()

virtual void Graphic3d_CView::FBORelease ( Handle< Standard_Transient > &  theFbo)
pure virtual

Remove offscreen FBO from the graphic library.

Implemented in OpenGl_View.

◆ GetGraduatedTrihedron()

virtual const Graphic3d_GraduatedTrihedron& Graphic3d_CView::GetGraduatedTrihedron ( )
pure virtual

Returns data of a graduated trihedron.

Implemented in OpenGl_View.

◆ GradientBackground()

virtual Aspect_GradientBackground Graphic3d_CView::GradientBackground ( ) const
pure virtual

Returns gradient background fill colors.

Implemented in OpenGl_View.

◆ GraduatedTrihedronDisplay()

virtual void Graphic3d_CView::GraduatedTrihedronDisplay ( const Graphic3d_GraduatedTrihedron theTrihedronData)
pure virtual

Displays Graduated Trihedron.

Implemented in OpenGl_View.

◆ GraduatedTrihedronErase()

virtual void Graphic3d_CView::GraduatedTrihedronErase ( )
pure virtual

Erases Graduated Trihedron.

Implemented in OpenGl_View.

◆ GraduatedTrihedronMinMaxValues()

virtual void Graphic3d_CView::GraduatedTrihedronMinMaxValues ( const Graphic3d_Vec3  theMin,
const Graphic3d_Vec3  theMax 
)
pure virtual

Sets minimum and maximum points of scene bounding box for Graduated Trihedron stored in graphic view object.

Parameters
theMin[in] the minimum point of scene.
theMax[in] the maximum point of scene.

Implemented in OpenGl_View.

◆ HiddenObjects()

const Handle< Graphic3d_NMapOfTransient >& Graphic3d_CView::HiddenObjects ( ) const
inline

Returns map of objects hidden within this specific view (not viewer-wise).

◆ Identification()

Standard_Integer Graphic3d_CView::Identification ( ) const
inline

Returns the identification number of the view.

◆ Invalidate()

virtual void Graphic3d_CView::Invalidate ( )
pure virtual

Invalidates content of the view but does not redraw it.

Implemented in OpenGl_View.

◆ InvalidateBVHData()

virtual void Graphic3d_CView::InvalidateBVHData ( const Graphic3d_ZLayerId  theLayerId)
pure virtual

Marks BVH tree and the set of BVH primitives of correspondent priority list with id theLayerId as outdated.

Implemented in OpenGl_View.

◆ InvalidateZLayerBoundingBox()

virtual void Graphic3d_CView::InvalidateZLayerBoundingBox ( const Graphic3d_ZLayerId  theLayerId) const
pure virtual

Returns the bounding box of all structures displayed in the Z layer.

Implemented in OpenGl_View.

◆ IsActive()

Standard_Boolean Graphic3d_CView::IsActive ( ) const
inline

Returns the activity flag of the view.

◆ IsComputed()

Standard_Boolean Graphic3d_CView::IsComputed ( const Standard_Integer  theStructId,
Handle< Graphic3d_Structure > &  theComputedStruct 
) const

Returns Standard_True in case if the structure with the given <theStructId> is in list of structures to be computed and stores computed struct to <theComputedStruct>.

◆ IsDefined()

virtual Standard_Boolean Graphic3d_CView::IsDefined ( ) const
pure virtual

Returns True if the window associated to the view is defined.

Implemented in OpenGl_View.

◆ IsInvalidated()

virtual Standard_Boolean Graphic3d_CView::IsInvalidated ( )
pure virtual

Return true if view content cache has been invalidated.

Implemented in OpenGl_View.

◆ IsRemoved()

Standard_Boolean Graphic3d_CView::IsRemoved ( ) const
inline

Returns true if the view was removed.

◆ Lights()

virtual const Handle< Graphic3d_LightSet >& Graphic3d_CView::Lights ( ) const
pure virtual

Returns list of lights of the view.

Implemented in OpenGl_View.

◆ MinMaxValues() [1/2]

virtual Bnd_Box Graphic3d_CView::MinMaxValues ( const Standard_Boolean  theToIncludeAuxiliary = Standard_False) const
virtual

Returns the bounding box of all structures displayed in the view. If theToIncludeAuxiliary is TRUE, then the boundary box also includes minimum and maximum limits of graphical elements forming parts of infinite and other auxiliary structures.

Parameters
theToIncludeAuxiliaryconsider also auxiliary presentations (with infinite flag or with trihedron transformation persistence)
Returns
computed bounding box

◆ MinMaxValues() [2/2]

Bnd_Box Graphic3d_CView::MinMaxValues ( const Graphic3d_MapOfStructure theSet,
const Standard_Boolean  theToIncludeAuxiliary = Standard_False 
) const

Returns the coordinates of the boundary box of all structures in the set <theSet>. If <theToIgnoreInfiniteFlag> is TRUE, then the boundary box also includes minimum and maximum limits of graphical elements forming parts of infinite structures.

◆ NumberOfDisplayedStructures()

virtual Standard_Integer Graphic3d_CView::NumberOfDisplayedStructures ( ) const
inlinevirtual

Returns number of displayed structures in the view.

◆ ReCompute()

void Graphic3d_CView::ReCompute ( const Handle< Graphic3d_Structure > &  theStructure)

Computes the new presentation of the structure displayed in this view with the type Graphic3d_TOS_COMPUTED.

◆ Redraw()

virtual void Graphic3d_CView::Redraw ( )
pure virtual

Redraw content of the view.

Implemented in OpenGl_View.

◆ RedrawImmediate()

virtual void Graphic3d_CView::RedrawImmediate ( )
pure virtual

Redraw immediate content of the view.

Implemented in OpenGl_View.

◆ Remove()

virtual void Graphic3d_CView::Remove ( )
virtual

Erases the view and removes from graphic driver. No more graphic operations are allowed in this view after the call.

Reimplemented in OpenGl_View.

◆ RemoveZLayer()

virtual void Graphic3d_CView::RemoveZLayer ( const Graphic3d_ZLayerId  theLayerId)
pure virtual

Remove Z layer from the specified view. All structures displayed at the moment in layer will be displayed in default layer ( the bottom-level z layer ). To unset layer ID from associated structures use method UnsetZLayer (...).

Implemented in OpenGl_View.

◆ RenderingParams()

const Graphic3d_RenderingParams& Graphic3d_CView::RenderingParams ( ) const
inline

Returns current rendering parameters and effect settings.

◆ Resized()

virtual void Graphic3d_CView::Resized ( )
pure virtual

Handle changing size of the rendering window.

Implemented in OpenGl_View.

◆ SetBackfacingModel()

virtual void Graphic3d_CView::SetBackfacingModel ( const Graphic3d_TypeOfBackfacingModel  theModel)
pure virtual

Sets backfacing model for the view.

Implemented in OpenGl_View.

◆ SetBackground()

virtual void Graphic3d_CView::SetBackground ( const Aspect_Background theBackground)
pure virtual

Sets background fill color.

Implemented in OpenGl_View.

◆ SetBackgroundImage()

virtual void Graphic3d_CView::SetBackgroundImage ( const TCollection_AsciiString theFilePath)
pure virtual

Sets background image texture file path.

Implemented in OpenGl_View.

◆ SetBackgroundImageStyle()

virtual void Graphic3d_CView::SetBackgroundImageStyle ( const Aspect_FillMethod  theFillStyle)
pure virtual

Sets background image fill style.

Implemented in OpenGl_View.

◆ SetCamera()

virtual void Graphic3d_CView::SetCamera ( const Handle< Graphic3d_Camera > &  theCamera)
pure virtual

Sets camera used by the view.

Implemented in OpenGl_View.

◆ SetClipPlanes()

virtual void Graphic3d_CView::SetClipPlanes ( const Handle< Graphic3d_SequenceOfHClipPlane > &  thePlanes)
pure virtual

Sets list of clip planes for the view.

Implemented in OpenGl_View.

◆ SetComputedMode()

void Graphic3d_CView::SetComputedMode ( const Standard_Boolean  theMode)

Switches computed HLR mode in the view.

◆ SetFBO()

virtual void Graphic3d_CView::SetFBO ( const Handle< Standard_Transient > &  theFbo)
pure virtual

Sets framebuffer object for offscreen rendering.

Implemented in OpenGl_View.

◆ SetGradientBackground()

virtual void Graphic3d_CView::SetGradientBackground ( const Aspect_GradientBackground theBackground)
pure virtual

Sets gradient background fill colors.

Implemented in OpenGl_View.

◆ SetImmediateModeDrawToFront()

virtual Standard_Boolean Graphic3d_CView::SetImmediateModeDrawToFront ( const Standard_Boolean  theDrawToFrontBuffer)
pure virtual
Parameters
theDrawToFrontBufferAdvanced option to modify rendering mode:
  1. TRUE. Drawing immediate mode structures directly to the front buffer over the scene image. Fast, so preferred for interactive work (used by default). However these extra drawings will be missed in image dump since it is performed from back buffer. Notice that since no pre-buffering used the V-Sync will be ignored and rendering could be seen in run-time (in case of slow hardware) and/or tearing may appear. So this is strongly recommended to draw only simple (fast) structures.
  2. FALSE. Drawing immediate mode structures to the back buffer. The complete scene is redrawn first, so this mode is slower if scene contains complex data and/or V-Sync is turned on. But it works in any case and is especially useful for view dump because the dump image is read from the back buffer.
Returns
previous mode.

Implemented in OpenGl_View.

◆ SetLights()

virtual void Graphic3d_CView::SetLights ( const Handle< Graphic3d_LightSet > &  theLights)
pure virtual

Sets list of lights for the view.

Implemented in OpenGl_View.

◆ SetShadingModel()

void Graphic3d_CView::SetShadingModel ( Graphic3d_TypeOfShadingModel  theModel)

Sets default Shading Model of the view. Will throw an exception on attempt to set Graphic3d_TOSM_DEFAULT.

◆ SetTextureEnv()

virtual void Graphic3d_CView::SetTextureEnv ( const Handle< Graphic3d_TextureEnv > &  theTextureEnv)
pure virtual

Sets environment texture for the view.

Implemented in OpenGl_View.

◆ SetVisualizationType()

void Graphic3d_CView::SetVisualizationType ( const Graphic3d_TypeOfVisualization  theType)
inline

Sets visualization type of the view.

◆ SetWindow()

virtual void Graphic3d_CView::SetWindow ( const Handle< Aspect_Window > &  theWindow,
const Aspect_RenderingContext  theContext = NULL 
)
pure virtual

Creates and maps rendering window to the view.

Parameters
theWindow[in] the window.
theContext[in] the rendering context. If NULL the context will be created internally.

Implemented in OpenGl_View.

◆ SetZLayerSettings()

virtual void Graphic3d_CView::SetZLayerSettings ( const Graphic3d_ZLayerId  theLayerId,
const Graphic3d_ZLayerSettings theSettings 
)
pure virtual

Sets the settings for a single Z layer of specified view.

Implemented in OpenGl_View.

◆ ShadingModel()

Graphic3d_TypeOfShadingModel Graphic3d_CView::ShadingModel ( ) const
inline

Returns default Shading Model of the view; Graphic3d_TOSM_FRAGMENT by default.

◆ StatisticInformation() [1/2]

virtual TCollection_AsciiString Graphic3d_CView::StatisticInformation ( ) const
pure virtual

Returns string with statistic performance info.

Implemented in OpenGl_View.

◆ StatisticInformation() [2/2]

virtual void Graphic3d_CView::StatisticInformation ( TColStd_IndexedDataMapOfStringString theDict) const
pure virtual

Fills in the dictionary with statistic performance info.

Implemented in OpenGl_View.

◆ StructureManager()

const Handle< Graphic3d_StructureManager >& Graphic3d_CView::StructureManager ( ) const
inline

Returns the structure manager handle which manage structures associated with this view.

◆ TextureEnv()

virtual Handle< Graphic3d_TextureEnv > Graphic3d_CView::TextureEnv ( ) const
pure virtual

Returns environment texture set for the view.

Implemented in OpenGl_View.

◆ Update()

void Graphic3d_CView::Update ( const Graphic3d_ZLayerId  theLayerId = Graphic3d_ZLayerId_UNKNOWN)

Invalidates bounding box of specified ZLayerId.

◆ VisualizationType()

Graphic3d_TypeOfVisualization Graphic3d_CView::VisualizationType ( ) const
inline

Returns visualization type of the view.

◆ Window()

virtual Handle< Aspect_Window > Graphic3d_CView::Window ( ) const
pure virtual

Returns the window associated to the view.

Implemented in OpenGl_View.

◆ ZLayerBoundingBox()

virtual Bnd_Box Graphic3d_CView::ZLayerBoundingBox ( const Graphic3d_ZLayerId  theLayerId,
const Handle< Graphic3d_Camera > &  theCamera,
const Standard_Integer  theWindowWidth,
const Standard_Integer  theWindowHeight,
const Standard_Boolean  theToIncludeAuxiliary 
) const
pure virtual

Returns the bounding box of all structures displayed in the Z layer.

Parameters
theLayerIdlayer identifier
theCameracamera definition
theWindowWidthviewport width (for applying transformation-persistence)
theWindowHeightviewport height (for applying transformation-persistence)
theToIncludeAuxiliaryconsider also auxiliary presentations (with infinite flag or with trihedron transformation persistence)
Returns
computed bounding box

Implemented in OpenGl_View.

◆ ZLayerMax()

virtual Standard_Integer Graphic3d_CView::ZLayerMax ( ) const
pure virtual

Returns the maximum Z layer ID. First layer ID is Graphic3d_ZLayerId_Default, last ID is ZLayerMax().

Implemented in OpenGl_View.

Field Documentation

◆ myHiddenObjects

Handle< Graphic3d_NMapOfTransient > Graphic3d_CView::myHiddenObjects
protected

◆ myId

Standard_Integer Graphic3d_CView::myId
protected

◆ myIsActive

Standard_Boolean Graphic3d_CView::myIsActive
protected

◆ myIsInComputedMode

Standard_Boolean Graphic3d_CView::myIsInComputedMode
protected

◆ myIsRemoved

Standard_Boolean Graphic3d_CView::myIsRemoved
protected

◆ myRenderParams

Graphic3d_RenderingParams Graphic3d_CView::myRenderParams
protected

◆ myShadingModel

Graphic3d_TypeOfShadingModel Graphic3d_CView::myShadingModel
protected

◆ myStructsComputed

Graphic3d_SequenceOfStructure Graphic3d_CView::myStructsComputed
protected

◆ myStructsDisplayed

Graphic3d_MapOfStructure Graphic3d_CView::myStructsDisplayed
protected

◆ myStructsToCompute

Graphic3d_SequenceOfStructure Graphic3d_CView::myStructsToCompute
protected

◆ myStructureManager

Handle< Graphic3d_StructureManager > Graphic3d_CView::myStructureManager
protected

◆ myVisualization

Graphic3d_TypeOfVisualization Graphic3d_CView::myVisualization
protected

The documentation for this class was generated from the following file: