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:

[legend]

Data Structures
struct	CachedMinMax

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. Map the associated window on the screen and post the view in this window. Warning: Raises ViewDefinitionError if the associated window isn't defined. More...

virtual void	Deactivate ()
	Deactivates the view. Unmap the associated window on the screen and unpost the view in this window. Warning: Raises ViewDefinitionError if the associated window isn't defined. 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_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 Aspect_TypeOfUpdate theUpdateMode)
	Updates screen in function of modifications of the structures. 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...

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...

Bnd_Box	MinMaxValues (const Standard_Boolean theToIgnoreInfiniteFlag=Standard_False) const
	Returns the coordinates of the boundary box of all structures displayed in the view. If <theToIgnoreInfiniteFlag> is TRUE, then the boundary box also includes minimum and maximum limits of graphical elements forming parts of infinite structures. More...

Bnd_Box	MinMaxValues (const Graphic3d_MapOfStructure &theSet, const Standard_Boolean theToIgnoreInfiniteFlag=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_Window >	Window () 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 void	TriedronDisplay (const Aspect_TypeOfTriedronPosition thePosition=Aspect_TOTP_CENTER, const Quantity_NameOfColor theColor=Quantity_NOC_WHITE, const Standard_Real theScale=0.02, const Standard_Boolean theAsWireframe=Standard_True)=0
	Displays z-buffer trihedron. More...

virtual void	TriedronErase ()=0
	Erases z-buffer trihedron. More...

virtual void	ZBufferTriedronSetup (const Quantity_NameOfColor theXColor=Quantity_NOC_RED, const Quantity_NameOfColor theYColor=Quantity_NOC_GREEN, const Quantity_NameOfColor theZColor=Quantity_NOC_BLUE1, const Standard_Real theSizeRatio=0.8, const Standard_Real theAxisDiametr=0.05, const Standard_Integer theNbFacettes=12)=0
	Setup parameters of z-buffer trihedron. More...

virtual void	TriedronEcho (const Aspect_TypeOfTriedronEcho theType=Aspect_TOTE_NONE)=0
	Displays trihedron echo. More...

virtual const Graphic3d_GraduatedTrihedron &	GetGraduatedTrihedron ()=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 Standard_Boolean	Print (const Aspect_Handle thePrinterDC, const Standard_Boolean theToShowBackground, const Standard_CString theFileName, const Aspect_PrintAlgo thePrintAlgorithm=Aspect_PA_STRETCH, const Standard_Real theScaleFactor=1.0)=0
	Print the contents of the view to the printer. More...

virtual Standard_Boolean	Export (const Standard_CString theFileName, const Graphic3d_ExportFormat theFormat, const Graphic3d_SortType theSortType=Graphic3d_ST_BSP_Tree)=0
	Export scene into the one of the Vector graphics formats (SVG, PS, PDF...). In contrast to Bitmaps, Vector graphics is scalable (so you may got quality benefits on printing to laser printer). Notice however that results may differ a lot and do not contain some elements. More...

virtual void	InvalidateBVHData (const Standard_Integer 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 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...

virtual Handle< Standard_Transient >	FBO () 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_Transient >	FBOCreate (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_RenderingParams &	RenderingParams () const
	Returns current rendering parameters and effect settings. More...

Graphic3d_RenderingParams &	ChangeRenderingParams ()
	Returns reference to current rendering parameters and effect settings. More...

virtual Standard_Boolean	IsAntialiasingEnabled () const =0
	Returns true if anti-aliasing is enabled for the view. More...

virtual void	SetAntialiasingEnabled (const Standard_Boolean theIsEnabled)=0
	Enable or disable anti-aliasing in the view. 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_TextureEnv >	TextureEnv () 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 Standard_Boolean	IsCullingEnabled () const =0
	Returns the state of frustum culling optimization. More...

virtual void	SetCullingEnabled (const Standard_Boolean theIsEnabled)=0
	Enables or disables frustum culling optimization. More...

virtual Graphic3d_TypeOfShadingModel	ShadingModel () const =0
	Returns shading model of the view. More...

virtual void	SetShadingModel (const Graphic3d_TypeOfShadingModel theModel)=0
	Sets shading model of the view. More...

virtual Graphic3d_TypeOfSurfaceDetail	SurfaceDetailType () const =0
	Returns surface detail type of the view. More...

virtual void	SetSurfaceDetailType (const Graphic3d_TypeOfSurfaceDetail theType)=0
	Sets surface detail type of 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 Standard_Boolean	BackZClippingIsOn () const =0
	Returns the activity of back z-clipping plane. More...

virtual void	SetBackZClippingOn (const Standard_Boolean theIsOn)=0
	Activates the back Z-clipping plane. More...

virtual Standard_Real	ZClippingBackPlane () const =0
	Returns the definition of the back Z-clipping plane. More...

virtual void	SetZClippingBackPlane (const Standard_Real theValue)=0
	Sets the definition of the back Z-clipping plane. More...

virtual Standard_Boolean	FrontZClippingIsOn () const =0
	Returns the activity of front z-clipping plane. More...

virtual void	SetFrontZClippingOn (const Standard_Boolean theIsOn)=0
	Activates the front Z-clipping plane. More...

virtual Standard_Real	ZClippingFrontPlane () const =0
	Returns the definition of the front Z-clipping plane. More...

virtual void	SetZClippingFrontPlane (const Standard_Real theValue)=0
	Sets the definition of the front Z-clipping plane. More...

virtual Standard_Boolean	DepthCueingIsOn () const =0
	Returns the activity of depth cueing. More...

virtual void	SetDepthCueingOn (const Standard_Boolean theIsOn)=0
	Sets the activity of depth cueing. More...

virtual Standard_Real	DepthCueingBackPlane () const =0
	Returns the back depth cueing plane. More...

virtual void	SetDepthCueingBackPlane (const Standard_Real theValue)=0
	Set the back depth cueing plane. More...

virtual Standard_Real	DepthCueingFrontPlane () const =0
	Returns the front depth cueing plane. More...

virtual void	SetDepthCueingFrontPlane (const Standard_Real theValue)=0
	Set the front depth cueing plane. More...

virtual Standard_Boolean	IsGLLightEnabled () const =0
	Returns true if GL lighting is enabled. More...

virtual void	SetGLLightEnabled (const Standard_Boolean theIsEnabled)=0
	Sets GL lighting enabled or disable state. More...

virtual const Graphic3d_ListOfCLight &	Lights () const =0
	Returns list of lights of the view. More...

virtual void	SetLights (const Graphic3d_ListOfCLight &theLights)=0
	Sets list of lights for the view. More...

virtual const Graphic3d_SequenceOfHClipPlane &	ClipPlanes () const =0
	Returns list of clip planes set for the view. More...

virtual void	SetClipPlanes (const Graphic3d_SequenceOfHClipPlane &thePlanes)=0
	Sets list of clip planes for the view. More...

Public Member Functions inherited from MMgt_TShared
virtual void	Delete () const override
	Memory deallocator for transient classes. More...

Public Member Functions inherited from Standard_Transient
	Standard_Transient ()
	Empty constructor. More...

	Standard_Transient (const Standard_Transient &)
	Copy constructor – does nothing. More...

Standard_Transient &	operator= (const Standard_Transient &)
	Assignment operator, needed to avoid copying reference counter. More...

virtual	~Standard_Transient ()
	Destructor must be virtual. 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_Transient *	This () 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...

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 ( const Handle< Graphic3d_StructureManager > & theMgr )

Constructor.

virtual Graphic3d_CView::~Graphic3d_CView ( )

virtual

Destructor.

Member Function Documentation

virtual void Graphic3d_CView::Activate ( )

virtual

Activates the view. Map the associated window on the screen and post the view in this window. Warning: Raises ViewDefinitionError if the associated window isn't defined.

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.

virtual Graphic3d_TypeOfBackfacingModel Graphic3d_CView::BackfacingModel ( ) const

pure virtual

Return backfacing model used for the view.

Implemented in OpenGl_View.

virtual Aspect_Background Graphic3d_CView::Background ( ) const

pure virtual

Returns background fill color.

Implemented in OpenGl_View.

virtual TCollection_AsciiString Graphic3d_CView::BackgroundImage ( )

pure virtual

Returns background image texture file path.

Implemented in OpenGl_View.

virtual Aspect_FillMethod Graphic3d_CView::BackgroundImageStyle ( ) const

pure virtual

Returns background image fill style.

Implemented in OpenGl_View.

virtual Standard_Boolean Graphic3d_CView::BackZClippingIsOn ( ) const

pure virtual

Returns the activity of back z-clipping plane.

Implemented in OpenGl_View.

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.

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

pure virtual

Returns camera object of the view.

Implemented in OpenGl_View.

Handle< Graphic3d_NMapOfTransient >& Graphic3d_CView::ChangeHiddenObjects ( )

inline

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

Graphic3d_RenderingParams& Graphic3d_CView::ChangeRenderingParams ( )

inline

Returns reference to current rendering parameters and effect settings.

virtual const Graphic3d_SequenceOfHClipPlane& Graphic3d_CView::ClipPlanes ( ) const

pure virtual

Returns list of clip planes set for the view.

Implemented in OpenGl_View.

Standard_Boolean Graphic3d_CView::ComputedMode ( ) const

inline

Returns the computed HLR mode state.

Standard_Boolean Graphic3d_CView::ContainsFacet ( ) const

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

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.

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.

virtual void Graphic3d_CView::Deactivate ( )

virtual

Deactivates the view. Unmap the associated window on the screen and unpost the view in this window. Warning: Raises ViewDefinitionError if the associated window isn't defined.

virtual Standard_Real Graphic3d_CView::DepthCueingBackPlane ( ) const

pure virtual

Returns the back depth cueing plane.

Implemented in OpenGl_View.

virtual Standard_Real Graphic3d_CView::DepthCueingFrontPlane ( ) const

pure virtual

Returns the front depth cueing plane.

Implemented in OpenGl_View.

virtual Standard_Boolean Graphic3d_CView::DepthCueingIsOn ( ) const

pure virtual

Returns the activity of depth cueing.

Implemented in OpenGl_View.

void Graphic3d_CView::DisplayedStructures ( Graphic3d_MapOfStructure & theStructures ) const

Returns the set of structures displayed in this view.

virtual Standard_Boolean Graphic3d_CView::Export	(	const Standard_CString	theFileName,
		const Graphic3d_ExportFormat	theFormat,
		const Graphic3d_SortType	theSortType = `Graphic3d_ST_BSP_Tree`
	)

pure virtual

Export scene into the one of the Vector graphics formats (SVG, PS, PDF...). In contrast to Bitmaps, Vector graphics is scalable (so you may got quality benefits on printing to laser printer). Notice however that results may differ a lot and do not contain some elements.

Implemented in OpenGl_View.

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

pure virtual

Returns pointer to an assigned framebuffer object.

Implemented in OpenGl_View.

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.

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.

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.

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

pure virtual

Remove offscreen FBO from the graphic library.

Implemented in OpenGl_View.

virtual Standard_Boolean Graphic3d_CView::FrontZClippingIsOn ( ) const

pure virtual

Returns the activity of front z-clipping plane.

Implemented in OpenGl_View.

virtual const Graphic3d_GraduatedTrihedron& Graphic3d_CView::GetGraduatedTrihedron ( )

pure virtual

Returns data of a graduated trihedron.

Implemented in OpenGl_View.

virtual Aspect_GradientBackground Graphic3d_CView::GradientBackground ( ) const

pure virtual

Returns gradient background fill colors.

Implemented in OpenGl_View.

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

pure virtual

Displays Graduated Trihedron.

Implemented in OpenGl_View.

virtual void Graphic3d_CView::GraduatedTrihedronErase ( )

pure virtual

Erases Graduated Trihedron.

Implemented in OpenGl_View.

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.

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

inline

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

Standard_Integer Graphic3d_CView::Identification ( ) const

inline

Returns the identification number of the view.

virtual void Graphic3d_CView::Invalidate ( )

pure virtual

Invalidates content of the view but does not redraw it.

Implemented in OpenGl_View.

virtual void Graphic3d_CView::InvalidateBVHData ( const Standard_Integer 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.

Standard_Boolean Graphic3d_CView::IsActive ( ) const

inline

Returns the activity flag of the view.

virtual Standard_Boolean Graphic3d_CView::IsAntialiasingEnabled ( ) const

pure virtual

Returns true if anti-aliasing is enabled for the view.

Implemented in OpenGl_View.

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>.

virtual Standard_Boolean Graphic3d_CView::IsCullingEnabled ( ) const

pure virtual

Returns the state of frustum culling optimization.

Implemented in OpenGl_View.

virtual Standard_Boolean Graphic3d_CView::IsDefined ( ) const

pure virtual

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

Implemented in OpenGl_View.

virtual Standard_Boolean Graphic3d_CView::IsGLLightEnabled ( ) const

pure virtual

Returns true if GL lighting is enabled.

Implemented in OpenGl_View.

virtual Standard_Boolean Graphic3d_CView::IsInvalidated ( )

pure virtual

Return true if view content cache has been invalidated.

Implemented in OpenGl_View.

Standard_Boolean Graphic3d_CView::IsRemoved ( ) const

inline

Returns true if the view was removed.

virtual const Graphic3d_ListOfCLight& Graphic3d_CView::Lights ( ) const

pure virtual

Returns list of lights of the view.

Implemented in OpenGl_View.

Bnd_Box Graphic3d_CView::MinMaxValues ( const Standard_Boolean theToIgnoreInfiniteFlag = Standard_False ) const

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

Bnd_Box Graphic3d_CView::MinMaxValues	(	const Graphic3d_MapOfStructure &	theSet,
		const Standard_Boolean	theToIgnoreInfiniteFlag = `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.

Standard_Integer Graphic3d_CView::NumberOfDisplayedStructures ( ) const

inline

Returns number of displayed structures in the view.

virtual Standard_Boolean Graphic3d_CView::Print	(	const Aspect_Handle	thePrinterDC,
		const Standard_Boolean	theToShowBackground,
		const Standard_CString	theFileName,
		const Aspect_PrintAlgo	thePrintAlgorithm = `Aspect_PA_STRETCH`,
		const Standard_Real	theScaleFactor = `1.0`
	)

pure virtual

Print the contents of the view to the printer.

Parameters

thePrinterDC	pass the PrinterDeviceContext (HDC)
theToShowBackground	when set to FALSE then print the view without background color (background is white) else set to TRUE for printing with current background color
theFileName	if != NULL, then the view will be printed to a file
thePrintAlgorithm	select print algorithm: stretch, tile
theScaleFactor	scaling coefficient, used internally to scale the printings accordingly to the scale factor selected in the printer properties dialog

Returns: Standard_True if the data is passed to the printer, otherwise Standard_False if the print operation failed due to the printer errors, or lack of system memory. This might be related to insufficient memory or some internal errors. All this errors are indicated by the message boxes (on level of OpenGl_GraphicDriver). Warning: This function can reuse FBO assigned to the view, please take it into account if you use it for your purposes.

Implemented in OpenGl_View.

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.

virtual void Graphic3d_CView::Redraw ( )

pure virtual

Redraw content of the view.

Implemented in OpenGl_View, and D3DHost_View.

virtual void Graphic3d_CView::RedrawImmediate ( )

pure virtual

Redraw immediate content of the view.

Implemented in OpenGl_View, and D3DHost_View.

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.

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.

const Graphic3d_RenderingParams& Graphic3d_CView::RenderingParams ( ) const

inline

Returns current rendering parameters and effect settings.

virtual void Graphic3d_CView::Resized ( )

pure virtual

Handle changing size of the rendering window.

Implemented in OpenGl_View, and D3DHost_View.

virtual void Graphic3d_CView::SetAntialiasingEnabled ( const Standard_Boolean theIsEnabled )

pure virtual

Enable or disable anti-aliasing in the view.

Implemented in OpenGl_View.

virtual void Graphic3d_CView::SetBackfacingModel ( const Graphic3d_TypeOfBackfacingModel theModel )

pure virtual

Sets backfacing model for the view.

Implemented in OpenGl_View.

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

pure virtual

Sets background fill color.

Implemented in OpenGl_View.

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

pure virtual

Sets background image texture file path.

Implemented in OpenGl_View.

virtual void Graphic3d_CView::SetBackgroundImageStyle ( const Aspect_FillMethod theFillStyle )

pure virtual

Sets background image fill style.

Implemented in OpenGl_View.

virtual void Graphic3d_CView::SetBackZClippingOn ( const Standard_Boolean theIsOn )

pure virtual

Activates the back Z-clipping plane.

Implemented in OpenGl_View.

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

pure virtual

Sets camera used by the view.

Implemented in OpenGl_View.

virtual void Graphic3d_CView::SetClipPlanes ( const Graphic3d_SequenceOfHClipPlane & thePlanes )

pure virtual

Sets list of clip planes for the view.

Implemented in OpenGl_View.

void Graphic3d_CView::SetComputedMode ( const Standard_Boolean theMode )

Switches computed HLR mode in the view.

virtual void Graphic3d_CView::SetCullingEnabled ( const Standard_Boolean theIsEnabled )

pure virtual

Enables or disables frustum culling optimization.

Implemented in OpenGl_View.

virtual void Graphic3d_CView::SetDepthCueingBackPlane ( const Standard_Real theValue )

pure virtual

Set the back depth cueing plane.

Implemented in OpenGl_View.

virtual void Graphic3d_CView::SetDepthCueingFrontPlane ( const Standard_Real theValue )

pure virtual

Set the front depth cueing plane.

Implemented in OpenGl_View.

virtual void Graphic3d_CView::SetDepthCueingOn ( const Standard_Boolean theIsOn )

pure virtual

Sets the activity of depth cueing.

Implemented in OpenGl_View.

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

pure virtual

Sets framebuffer object for offscreen rendering.

Implemented in OpenGl_View.

virtual void Graphic3d_CView::SetFrontZClippingOn ( const Standard_Boolean theIsOn )

pure virtual

Activates the front Z-clipping plane.

Implemented in OpenGl_View.

virtual void Graphic3d_CView::SetGLLightEnabled ( const Standard_Boolean theIsEnabled )

pure virtual

Sets GL lighting enabled or disable state.

Implemented in OpenGl_View.

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

pure virtual

Sets gradient background fill colors.

Implemented in OpenGl_View.

virtual Standard_Boolean Graphic3d_CView::SetImmediateModeDrawToFront ( const Standard_Boolean theDrawToFrontBuffer )

pure virtual

Parameters

theDrawToFrontBuffer

Advanced option to modify rendering mode:

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.
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.

virtual void Graphic3d_CView::SetLights ( const Graphic3d_ListOfCLight & theLights )

pure virtual

Sets list of lights for the view.

Implemented in OpenGl_View.

virtual void Graphic3d_CView::SetShadingModel ( const Graphic3d_TypeOfShadingModel theModel )

pure virtual

Sets shading model of the view.

Implemented in OpenGl_View.

virtual void Graphic3d_CView::SetSurfaceDetailType ( const Graphic3d_TypeOfSurfaceDetail theType )

pure virtual

Sets surface detail type of the view.

Implemented in OpenGl_View.

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

pure virtual

Sets environment texture for the view.

Implemented in OpenGl_View.

void Graphic3d_CView::SetVisualizationType ( const Graphic3d_TypeOfVisualization theType )

inline

Sets visualization type of the view.

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, and D3DHost_View.

virtual void Graphic3d_CView::SetZClippingBackPlane ( const Standard_Real theValue )

pure virtual

Sets the definition of the back Z-clipping plane.

Implemented in OpenGl_View.

virtual void Graphic3d_CView::SetZClippingFrontPlane ( const Standard_Real theValue )

pure virtual

Sets the definition of the front Z-clipping plane.

Implemented in OpenGl_View.

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.

virtual Graphic3d_TypeOfShadingModel Graphic3d_CView::ShadingModel ( ) const

pure virtual

Returns shading model of the view.

Implemented in OpenGl_View.

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

inline

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

virtual Graphic3d_TypeOfSurfaceDetail Graphic3d_CView::SurfaceDetailType ( ) const

pure virtual

Returns surface detail type of the view.

Implemented in OpenGl_View.

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

pure virtual

Returns environment texture set for the view.

Implemented in OpenGl_View.

virtual void Graphic3d_CView::TriedronDisplay	(	const Aspect_TypeOfTriedronPosition	thePosition = `Aspect_TOTP_CENTER`,
		const Quantity_NameOfColor	theColor = `Quantity_NOC_WHITE`,
		const Standard_Real	theScale = `0.02`,
		const Standard_Boolean	theAsWireframe = `Standard_True`
	)

pure virtual

Displays z-buffer trihedron.

Implemented in OpenGl_View.

virtual void Graphic3d_CView::TriedronEcho ( const Aspect_TypeOfTriedronEcho theType = Aspect_TOTE_NONE )

pure virtual

Displays trihedron echo.

Implemented in OpenGl_View.

virtual void Graphic3d_CView::TriedronErase ( )

pure virtual

Erases z-buffer trihedron.

Implemented in OpenGl_View.

void Graphic3d_CView::Update ( const Aspect_TypeOfUpdate theUpdateMode )

Updates screen in function of modifications of the structures.

Graphic3d_TypeOfVisualization Graphic3d_CView::VisualizationType ( ) const

inline

Returns visualization type of the view.

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

pure virtual

Returns the window associated to the view.

Implemented in OpenGl_View.

virtual void Graphic3d_CView::ZBufferTriedronSetup	(	const Quantity_NameOfColor	theXColor = `Quantity_NOC_RED`,
		const Quantity_NameOfColor	theYColor = `Quantity_NOC_GREEN`,
		const Quantity_NameOfColor	theZColor = `Quantity_NOC_BLUE1`,
		const Standard_Real	theSizeRatio = `0.8`,
		const Standard_Real	theAxisDiametr = `0.05`,
		const Standard_Integer	theNbFacettes = `12`
	)

pure virtual

Setup parameters of z-buffer trihedron.

Implemented in OpenGl_View.

virtual Standard_Real Graphic3d_CView::ZClippingBackPlane ( ) const

pure virtual

Returns the definition of the back Z-clipping plane.

Implemented in OpenGl_View.

virtual Standard_Real Graphic3d_CView::ZClippingFrontPlane ( ) const

pure virtual

Returns the definition of the front Z-clipping plane.

Implemented in OpenGl_View.

Field Documentation

Handle< Graphic3d_NMapOfTransient > Graphic3d_CView::myHiddenObjects

protected

Standard_Integer Graphic3d_CView::myId

protected

Standard_Boolean Graphic3d_CView::myIsActive

protected

Standard_Boolean Graphic3d_CView::myIsInComputedMode

protected

Standard_Boolean Graphic3d_CView::myIsRemoved

protected

CachedMinMax Graphic3d_CView::myMinMax

mutableprotected

Graphic3d_RenderingParams Graphic3d_CView::myRenderParams

protected

Graphic3d_SequenceOfStructure Graphic3d_CView::myStructsComputed

protected

Graphic3d_MapOfStructure Graphic3d_CView::myStructsDisplayed

protected

Graphic3d_SequenceOfStructure Graphic3d_CView::myStructsToCompute

protected

Handle< Graphic3d_StructureManager > Graphic3d_CView::myStructureManager

protected

Graphic3d_TypeOfVisualization Graphic3d_CView::myVisualization

protected

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

Graphic3d_CView.hxx

Protected Attributes
Standard_Integer	myId

Graphic3d_RenderingParams	myRenderParams

Handle< Graphic3d_StructureManager >	myStructureManager

Graphic3d_SequenceOfStructure	myStructsToCompute

Graphic3d_SequenceOfStructure	myStructsComputed

Graphic3d_MapOfStructure	myStructsDisplayed

Handle< Graphic3d_NMapOfTransient >	myHiddenObjects

Standard_Boolean	myIsInComputedMode

Standard_Boolean	myIsActive

Standard_Boolean	myIsRemoved

Graphic3d_TypeOfVisualization	myVisualization

CachedMinMax	myMinMax

Data Structures

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation