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]

Public Member Functions
	Graphic3d_CView (const occ::handle< Graphic3d_StructureManager > &theMgr)
	Constructor.

	~Graphic3d_CView () override
	Destructor.

int	Identification () const
	Returns the identification number of the view.

virtual void	Activate ()
	Activates the view. Maps presentations defined within structure manager onto this view.

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

bool	IsActive () const
	Returns the activity flag of the view.

virtual void	Remove ()
	Erases the view and removes from graphic driver. No more graphic operations are allowed in this view after the call.

bool	IsRemoved () const
	Returns true if the view was removed.

const occ::handle< Graphic3d_Camera > &	Camera () const override
	Returns camera object of the view.

virtual void	SetCamera (const occ::handle< Graphic3d_Camera > &theCamera)
	Sets camera used by the view.

virtual bool	ToFlipOutput () const
	Returns necessity to flip OY in projection matrix.

virtual void	SetToFlipOutput (const bool)
	Sets state of flip OY necessity in projection matrix.

Graphic3d_TypeOfShadingModel	ShadingModel () const
	Returns default Shading Model of the view; Graphic3d_TypeOfShadingModel_Phong by default.

void	SetShadingModel (Graphic3d_TypeOfShadingModel theModel)
	Sets default Shading Model of the view. Will throw an exception on attempt to set Graphic3d_TypeOfShadingModel_DEFAULT.

Graphic3d_TypeOfBackfacingModel	BackfacingModel () const
	Return backfacing model used for the view; Graphic3d_TypeOfBackfacingModel_Auto by default, which means that backface culling is defined by each presentation.

void	SetBackfacingModel (const Graphic3d_TypeOfBackfacingModel theModel)
	Sets backfacing model for the view.

Graphic3d_TypeOfVisualization	VisualizationType () const
	Returns visualization type of the view.

void	SetVisualizationType (const Graphic3d_TypeOfVisualization theType)
	Sets visualization type of the view.

Graphic3d_ZLayerId	ZLayerTarget () const
	Returns ZLayerId target.

void	SetZLayerTarget (const Graphic3d_ZLayerId theTarget)
	Sets ZLayerId target.

bool	ZLayerRedrawMode () const
	Returns ZLayerId redraw mode.

void	SetZLayerRedrawMode (const bool theMode)
	Sets ZLayerId redraw mode.

void	SetComputedMode (const bool theMode)
	Switches computed HLR mode in the view.

bool	ComputedMode () const
	Returns the computed HLR mode state.

void	ReCompute (const occ::handle< Graphic3d_Structure > &theStructure)
	Computes the new presentation of the structure displayed in this view with the type Graphic3d_TOS_COMPUTED.

void	Update (const Graphic3d_ZLayerId theLayerId=Graphic3d_ZLayerId_UNKNOWN)
	Invalidates bounding box of specified ZLayerId.

void	Compute ()
	Computes the new presentation of the structures displayed in this view with the type Graphic3d_TOS_COMPUTED.

void	DisplayedStructures (NCollection_Map< occ::handle< Graphic3d_Structure > > &theStructures) const
	Returns the set of structures displayed in this view.

virtual int	NumberOfDisplayedStructures () const
	Returns number of displayed structures in the view.

bool	IsComputed (const int theStructId, occ::handle< Graphic3d_Structure > &theComputedStruct) const
	Returns 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 Bnd_Box	MinMaxValues (const bool theToIncludeAuxiliary=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.

Bnd_Box	MinMaxValues (const NCollection_Map< occ::handle< Graphic3d_Structure > > &theSet, const bool theToIncludeAuxiliary=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.

const occ::handle< Graphic3d_StructureManager > &	StructureManager () const
	Returns the structure manager handle which manage structures associated with this view.

virtual void	Redraw ()=0
	Redraw content of the view.

virtual void	RedrawImmediate ()=0
	Redraw immediate content of the view.

virtual void	Invalidate ()=0
	Invalidates content of the view but does not redraw it.

virtual bool	IsInvalidated ()=0
	Return true if view content cache has been invalidated.

virtual void	Resized ()=0
	Handle changing size of the rendering window.

virtual bool	SetImmediateModeDrawToFront (const bool theDrawToFrontBuffer)=0

virtual void	SetWindow (const occ::handle< Graphic3d_CView > &theParentVIew, const occ::handle< Aspect_Window > &theWindow, const Aspect_RenderingContext theContext)=0
	Creates and maps rendering window to the view.

virtual occ::handle< Aspect_Window >	Window () const =0
	Returns the window associated to the view.

virtual bool	IsDefined () const =0
	Returns True if the window associated to the view is defined.

virtual bool	BufferDump (Image_PixMap &theImage, const Graphic3d_BufferType &theBufferType)=0
	Dump active rendering buffer into specified memory buffer.

virtual bool	ShadowMapDump (Image_PixMap &theImage, const TCollection_AsciiString &theLightName)=0
	Dumps the graphical contents of a shadowmap framebuffer into an image.

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.

virtual void	InsertLayerBefore (const Graphic3d_ZLayerId theNewLayerId, const Graphic3d_ZLayerSettings &theSettings, const Graphic3d_ZLayerId theLayerAfter)=0
	Add a layer to the view.

virtual void	InsertLayerAfter (const Graphic3d_ZLayerId theNewLayerId, const Graphic3d_ZLayerSettings &theSettings, const Graphic3d_ZLayerId theLayerBefore)=0
	Add a layer to the view.

virtual int	ZLayerMax () const =0
	Returns the maximum Z layer ID. First layer ID is Graphic3d_ZLayerId_Default, last ID is ZLayerMax().

virtual const NCollection_List< occ::handle< Graphic3d_Layer > > &	Layers () const =0
	Returns the list of layers.

virtual occ::handle< Graphic3d_Layer >	Layer (const Graphic3d_ZLayerId theLayerId) const =0
	Returns layer with given ID or NULL if undefined.

virtual void	InvalidateZLayerBoundingBox (const Graphic3d_ZLayerId theLayerId)
	Returns the bounding box of all structures displayed in the Z layer.

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

virtual void	SetZLayerSettings (const Graphic3d_ZLayerId theLayerId, const Graphic3d_ZLayerSettings &theSettings)=0
	Sets the settings for a single Z layer of specified view.

double	ConsiderZoomPersistenceObjects ()
	Returns zoom-scale factor.

virtual occ::handle< Standard_Transient >	FBO () const =0
	Returns pointer to an assigned framebuffer object.

virtual void	SetFBO (const occ::handle< Standard_Transient > &theFbo)=0
	Sets framebuffer object for offscreen rendering.

virtual occ::handle< Standard_Transient >	FBOCreate (const int theWidth, const int theHeight)=0
	Generate offscreen FBO in the graphic library. If not supported on hardware returns NULL.

virtual void	FBORelease (occ::handle< Standard_Transient > &theFbo)=0
	Remove offscreen FBO from the graphic library.

virtual void	FBOGetDimensions (const occ::handle< Standard_Transient > &theFbo, int &theWidth, int &theHeight, int &theWidthMax, int &theHeightMax)=0
	Read offscreen FBO configuration.

virtual void	FBOChangeViewport (const occ::handle< Standard_Transient > &theFbo, const int theWidth, const int theHeight)=0
	Change offscreen FBO viewport.

virtual void	CopySettings (const occ::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.

const Graphic3d_RenderingParams &	RenderingParams () const
	Returns current rendering parameters and effect settings.

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

virtual Aspect_Background	Background () const
	Returns background fill color.

virtual void	SetBackground (const Aspect_Background &theBackground)
	Sets background fill color.

virtual Aspect_GradientBackground	GradientBackground () const =0
	Returns gradient background fill colors.

virtual void	SetGradientBackground (const Aspect_GradientBackground &theBackground)=0
	Sets gradient background fill colors.

const occ::handle< Graphic3d_TextureMap > &	BackgroundImage ()
	Returns background image texture map.

const occ::handle< Graphic3d_CubeMap > &	BackgroundCubeMap () const
	Returns cubemap being set last time on background.

const occ::handle< Graphic3d_CubeMap > &	IBLCubeMap () const
	Returns cubemap being set last time on background.

virtual void	SetBackgroundImage (const occ::handle< Graphic3d_TextureMap > &theTextureMap, bool theToUpdatePBREnv=true)=0
	Sets image texture or environment cubemap as background.

virtual Aspect_FillMethod	BackgroundImageStyle () const =0
	Returns background image fill style.

virtual void	SetBackgroundImageStyle (const Aspect_FillMethod theFillStyle)=0
	Sets background image fill style.

Graphic3d_TypeOfBackground	BackgroundType () const
	Returns background type.

void	SetBackgroundType (Graphic3d_TypeOfBackground theType)
	Sets background type.

const Aspect_SkydomeBackground &	BackgroundSkydome () const
	Returns skydome aspect;.

void	SetBackgroundSkydome (const Aspect_SkydomeBackground &theAspect, bool theToUpdatePBREnv=true)
	Sets skydome aspect.

virtual void	SetImageBasedLighting (bool theToEnableIBL)=0
	Enables or disables IBL (Image Based Lighting) from background cubemap. Has no effect if PBR is not used.

virtual void	GridDisplay (const Aspect_GridParams &theParams, const gp_Ax3 &thePlane)
	Display a shader-rendered grid on the given plane. The default implementation is a no-op; drivers with shader support override it.

virtual void	GridErase ()
	Erase the shader-rendered grid. The default implementation is a no-op; drivers with shader support override it.

const occ::handle< Graphic3d_TextureEnv > &	TextureEnv () const
	Returns environment texture set for the view.

virtual void	SetTextureEnv (const occ::handle< Graphic3d_TextureEnv > &theTextureEnv)=0
	Sets environment texture for the view.

virtual const occ::handle< Graphic3d_LightSet > &	Lights () const =0
	Returns list of lights of the view.

virtual void	SetLights (const occ::handle< Graphic3d_LightSet > &theLights)=0
	Sets list of lights for the view.

virtual const occ::handle< Graphic3d_SequenceOfHClipPlane > &	ClipPlanes () const =0
	Returns list of clip planes set for the view.

virtual void	SetClipPlanes (const occ::handle< Graphic3d_SequenceOfHClipPlane > &thePlanes)=0
	Sets list of clip planes for the view.

virtual void	DiagnosticInformation (NCollection_IndexedDataMap< TCollection_AsciiString, TCollection_AsciiString > &theDict, Graphic3d_DiagnosticInfo theFlags) const =0
	Fill in the dictionary with diagnostic info. Should be called within rendering thread.

virtual TCollection_AsciiString	StatisticInformation () const =0
	Returns string with statistic performance info.

virtual void	StatisticInformation (NCollection_IndexedDataMap< TCollection_AsciiString, TCollection_AsciiString > &theDict) const =0
	Fills in the dictionary with statistic performance info.

double	UnitFactor () const
	Return unit scale factor defined as scale factor for m (meters); 1.0 by default. Normally, view definition is unitless, however some operations like VR input requires proper units mapping.

void	SetUnitFactor (double theFactor)
	Set unit scale factor.

const occ::handle< Aspect_XRSession > &	XRSession () const
	Return XR session.

void	SetXRSession (const occ::handle< Aspect_XRSession > &theSession)
	Set XR session.

bool	IsActiveXR () const
	Return TRUE if there is active XR session.

virtual bool	InitXR ()
	Initialize XR session.

virtual void	ReleaseXR ()
	Release XR session.

virtual void	ProcessXRInput ()
	Process input.

void	SetupXRPosedCamera ()
	Compute PosedXRCamera() based on current XR head pose and make it active.

void	UnsetXRPosedCamera ()
	Set current camera back to BaseXRCamera() and copy temporary modifications of PosedXRCamera(). Calls SynchronizeXRPosedToBaseCamera() beforehand.

const occ::handle< Graphic3d_Camera > &	PosedXRCamera () const
	Returns transient XR camera position with tracked head orientation applied.

void	SetPosedXRCamera (const occ::handle< Graphic3d_Camera > &theCamera)
	Sets transient XR camera position with tracked head orientation applied.

const occ::handle< Graphic3d_Camera > &	BaseXRCamera () const
	Returns anchor camera definition (without tracked head orientation).

void	SetBaseXRCamera (const occ::handle< Graphic3d_Camera > &theCamera)
	Sets anchor camera definition.

gp_Trsf	PoseXRToWorld (const gp_Trsf &thePoseXR) const
	Convert XR pose to world space.

gp_Ax1	ViewAxisInWorld (const gp_Trsf &thePoseXR) const
	Returns view direction in the world space based on XR pose.

void	SynchronizeXRBaseToPosedCamera ()
	Recomputes PosedXRCamera() based on BaseXRCamera() and head orientation.

void	SynchronizeXRPosedToBaseCamera ()
	Checks if PosedXRCamera() has been modified since SetupXRPosedCamera() and copies these modifications to BaseXRCamera().

void	ComputeXRPosedCameraFromBase (Graphic3d_Camera &theCam, const gp_Trsf &theXRTrsf) const
	Compute camera position based on XR pose.

void	ComputeXRBaseCameraFromPosed (const Graphic3d_Camera &theCamPosed, const gp_Trsf &thePoseTrsf)
	Update based camera from posed camera by applying reversed transformation.

void	TurnViewXRCamera (const gp_Trsf &theTrsfTurn)
	Turn XR camera direction using current (head) eye position as anchor.

obsolete Graduated Trihedron functionality
Returns data of a graduated trihedron
virtual const Graphic3d_GraduatedTrihedron &	GetGraduatedTrihedron ()
	Displays Graduated Trihedron.

virtual void	GraduatedTrihedronDisplay (const Graphic3d_GraduatedTrihedron &theTrihedronData)
	Displays Graduated Trihedron.

virtual void	GraduatedTrihedronErase ()
	Erases Graduated Trihedron.

virtual void	GraduatedTrihedronMinMaxValues (const NCollection_Vec3< float > theMin, const NCollection_Vec3< float > theMax)
	Sets minimum and maximum points of scene bounding box for Graduated Trihedron stored in graphic view object.

void	DumpJson (Standard_OStream &theOStream, int theDepth=-1) const override
	Dumps the content of me into the stream.

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

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

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

virtual	~Standard_Transient ()=default
	Destructor must be virtual.

virtual const opencascade::handle< Standard_Type > &	DynamicType () const
	Returns a type descriptor about this object.

bool	IsInstance (const opencascade::handle< Standard_Type > &theType) const
	Returns a true value if this is an instance of Type.

bool	IsInstance (const char *const theTypeName) const
	Returns a true value if this is an instance of TypeName.

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

bool	IsKind (const char *const 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.

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.

int	GetRefCount () const noexcept
	Get the reference counter of this object.

void	IncrementRefCounter () noexcept
	Increments the reference counter of this object. Uses relaxed memory ordering since incrementing only requires atomicity, not synchronization with other memory operations.

int	DecrementRefCounter () noexcept
	Decrements the reference counter of this object; returns the decremented value. Uses release ordering for the decrement to ensure all writes to the object are visible before the count reaches zero. An acquire fence is added only when the count reaches zero, ensuring proper synchronization before deletion. This is more efficient than using acq_rel for every decrement.

virtual void	Delete () const
	Memory deallocator for transient classes.

subview properties
Return TRUE if this is a subview of another view.
int	myId
	list of child views

Graphic3d_RenderingParams	myRenderParams
	list of child views

NCollection_Sequence< occ::handle< Graphic3d_CView > >	mySubviews
	list of child views

Graphic3d_CView *	myParentView
	back-pointer to the parent view

bool	myIsSubviewComposer
	flag to skip rendering of viewer contents

Aspect_TypeOfTriedronPosition	mySubviewCorner
	position within parent view

NCollection_Vec2< int >	mySubviewTopLeft
	subview top-left position relative to parent view

NCollection_Vec2< int >	mySubviewMargins
	subview margins in pixels

NCollection_Vec2< double >	mySubviewSize
	subview size

NCollection_Vec2< double >	mySubviewOffset
	subview corner offset within parent view

occ::handle< Graphic3d_StructureManager >	myStructureManager
	list of child views

occ::handle< Graphic3d_Camera >	myCamera
	list of child views

NCollection_Sequence< occ::handle< Graphic3d_Structure > >	myStructsToCompute
	list of child views

NCollection_Sequence< occ::handle< Graphic3d_Structure > >	myStructsComputed
	list of child views

NCollection_Map< occ::handle< Graphic3d_Structure > >	myStructsDisplayed
	list of child views

bool	myIsInComputedMode
	list of child views

bool	myIsActive
	list of child views

bool	myIsRemoved
	list of child views

Graphic3d_TypeOfBackfacingModel	myBackfacing
	list of child views

Graphic3d_TypeOfVisualization	myVisualization
	list of child views

Graphic3d_ZLayerId	myZLayerTarget
	ZLayerId for redrawing the content of specific zlayers.

bool	myZLayerRedrawMode
	If true redraws single layer, otherwise redraws group of layers.

Quantity_ColorRGBA	myBgColor
	list of child views

occ::handle< Graphic3d_TextureMap >	myBackgroundImage
	list of child views

occ::handle< Graphic3d_CubeMap >	myCubeMapBackground
	Cubemap displayed at background.

occ::handle< Graphic3d_CubeMap >	myCubeMapIBL
	Cubemap used for environment lighting.

occ::handle< Graphic3d_TextureEnv >	myTextureEnvData
	list of child views

Graphic3d_GraduatedTrihedron	myGTrihedronData
	list of child views

Graphic3d_TypeOfBackground	myBackgroundType
	Current type of background.

Aspect_SkydomeBackground	mySkydomeAspect
	list of child views

bool	myToUpdateSkydome
	list of child views

occ::handle< Aspect_XRSession >	myXRSession
	list of child views

occ::handle< Graphic3d_Camera >	myBackXRCamera
	camera projection parameters to restore after closing XR session (FOV, aspect and similar)

occ::handle< Graphic3d_Camera >	myBaseXRCamera
	neutral camera orientation defining coordinate system in which head tracking is defined

occ::handle< Graphic3d_Camera >	myPosedXRCamera
	transient XR camera orientation with tracked head orientation applied (based on myBaseXRCamera)

occ::handle< Graphic3d_Camera >	myPosedXRCameraCopy
	neutral camera orientation copy at the beginning of processing input

double	myUnitFactor
	unit scale factor defined as scale factor for m (meters)

bool	IsSubview () const
	list of child views

Graphic3d_CView *	ParentView ()
	Return parent View or NULL if this is not a subview.

bool	IsSubviewComposer () const
	Return TRUE if this is view performs rendering of subviews and nothing else; FALSE by default. By default, view with subviews will render main scene and blit subviews on top of it. Rendering of main scene might become redundant in case if subviews cover entire window of parent view. This flag allows to disable rendering of the main scene in such scenarios without creation of a dedicated V3d_Viewer instance just for composing subviews.

void	SetSubviewComposer (bool theIsComposer)
	Set if this view should perform composing of subviews and nothing else.

const NCollection_Sequence< occ::handle< Graphic3d_CView > > &	Subviews () const
	Return subview list.

void	AddSubview (const occ::handle< Graphic3d_CView > &theView)
	Add subview to the list.

bool	RemoveSubview (const Graphic3d_CView *theView)
	Remove subview from the list.

Aspect_TypeOfTriedronPosition	SubviewCorner () const
	Return subview position within parent view; Aspect_TOTP_LEFT_UPPER by default.

void	SetSubviewCorner (Aspect_TypeOfTriedronPosition thePos)
	Set subview position within parent view.

const NCollection_Vec2< int > &	SubviewTopLeft () const
	Return subview top-left position relative to parent view in pixels.

bool	IsSubViewRelativeSize () const
	Return TRUE if subview size is set as proportions relative to parent view.

const NCollection_Vec2< double > &	SubviewSize () const
	Return subview dimensions; (1.0, 1.0) by default. Values >= 2 define size in pixels; Values <= 1.0 define size as fraction of parent view.

void	SetSubviewSize (const NCollection_Vec2< double > &theSize)
	Set subview size relative to parent view.

const NCollection_Vec2< double > &	SubviewOffset () const
	Return corner offset within parent view; (0.0,0.0) by default. Values >= 2 define offset in pixels; Values <= 1.0 define offset as fraction of parent view dimensions.

void	SetSubviewOffset (const NCollection_Vec2< double > &theOffset)
	Set corner offset within parent view.

const NCollection_Vec2< int > &	SubviewMargins () const
	Return subview margins in pixels; (0,0) by default.

void	SetSubviewMargins (const NCollection_Vec2< int > &theMargins)
	Set subview margins in pixels.

void	SubviewResized (const occ::handle< Aspect_NeutralWindow > &theWindow)
	Update subview position and dimensions.

Additional Inherited Members
Public Types inherited from Standard_Transient
typedef void	base_type
	Returns a type descriptor about this object.

Static Public Member Functions inherited from Standard_Transient
static constexpr const char *	get_type_name ()
	Returns a type descriptor about this object.

static const opencascade::handle< Standard_Type > &	get_type_descriptor ()
	Returns type descriptor of Standard_Transient class.

Protected Member Functions inherited from Graphic3d_DataStructureManager
	Graphic3d_DataStructureManager ()
	Initializes the manager <me>.

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 occ::handle< Graphic3d_StructureManager > & theMgr )

Constructor.

◆ ~Graphic3d_CView()

Graphic3d_CView::~Graphic3d_CView ( )

override

Destructor.

Member Function Documentation

◆ Activate()

virtual void Graphic3d_CView::Activate ( )

virtual

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

◆ AddSubview()

void Graphic3d_CView::AddSubview ( const occ::handle< Graphic3d_CView > & theView )

Add subview to the list.

◆ BackfacingModel()

Graphic3d_TypeOfBackfacingModel Graphic3d_CView::BackfacingModel ( ) const

inline

Return backfacing model used for the view; Graphic3d_TypeOfBackfacingModel_Auto by default, which means that backface culling is defined by each presentation.

◆ Background()

virtual Aspect_Background Graphic3d_CView::Background ( ) const

inlinevirtual

Returns background fill color.

◆ BackgroundCubeMap()

const occ::handle< Graphic3d_CubeMap > & Graphic3d_CView::BackgroundCubeMap ( ) const

inline

Returns cubemap being set last time on background.

◆ BackgroundImage()

const occ::handle< Graphic3d_TextureMap > & Graphic3d_CView::BackgroundImage ( )

inline

Returns background image texture map.

◆ BackgroundImageStyle()

virtual Aspect_FillMethod Graphic3d_CView::BackgroundImageStyle ( ) const

pure virtual

Returns background image fill style.

Implemented in OpenGl_View.

◆ BackgroundSkydome()

const Aspect_SkydomeBackground & Graphic3d_CView::BackgroundSkydome ( ) const

inline

Returns skydome aspect;.

◆ BackgroundType()

Graphic3d_TypeOfBackground Graphic3d_CView::BackgroundType ( ) const

inline

Returns background type.

◆ BaseXRCamera()

const occ::handle< Graphic3d_Camera > & Graphic3d_CView::BaseXRCamera ( ) const

inline

Returns anchor camera definition (without tracked head orientation).

◆ BufferDump()

virtual bool 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()

const occ::handle< Graphic3d_Camera > & Graphic3d_CView::Camera ( ) const

inlineoverridevirtual

Returns camera object of the view.

Implements Graphic3d_DataStructureManager.

◆ ChangeRenderingParams()

Graphic3d_RenderingParams & Graphic3d_CView::ChangeRenderingParams ( )

inline

Returns reference to current rendering parameters and effect settings.

◆ ClipPlanes()

virtual const occ::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()

bool Graphic3d_CView::ComputedMode ( ) const

inline

Returns the computed HLR mode state.

◆ ComputeXRBaseCameraFromPosed()

void Graphic3d_CView::ComputeXRBaseCameraFromPosed	(	const Graphic3d_Camera &	theCamPosed,
		const gp_Trsf &	thePoseTrsf )

Update based camera from posed camera by applying reversed transformation.

◆ ComputeXRPosedCameraFromBase()

void Graphic3d_CView::ComputeXRPosedCameraFromBase	(	Graphic3d_Camera &	theCam,
		const gp_Trsf &	theXRTrsf ) const

Compute camera position based on XR pose.

◆ ConsiderZoomPersistenceObjects()

double Graphic3d_CView::ConsiderZoomPersistenceObjects ( )

Returns zoom-scale factor.

◆ CopySettings()

virtual void Graphic3d_CView::CopySettings ( const occ::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	(	NCollection_IndexedDataMap< TCollection_AsciiString, TCollection_AsciiString > &	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 D3DHost_View, and OpenGl_View.

◆ DisplayedStructures()

void Graphic3d_CView::DisplayedStructures ( NCollection_Map< occ::handle< Graphic3d_Structure > > & theStructures ) const

Returns the set of structures displayed in this view.

◆ DumpJson()

void Graphic3d_CView::DumpJson	(	Standard_OStream &	theOStream,
		int	theDepth = -1 ) const

overridevirtual

Dumps the content of me into the stream.

Reimplemented from Graphic3d_DataStructureManager.

◆ FBO()

virtual occ::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 occ::handle< Standard_Transient > &	theFbo,
		const int	theWidth,
		const int	theHeight )

pure virtual

Change offscreen FBO viewport.

Implemented in OpenGl_View.

◆ FBOCreate()

virtual occ::handle< Standard_Transient > Graphic3d_CView::FBOCreate	(	const int	theWidth,
		const int	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 occ::handle< Standard_Transient > &	theFbo,
		int &	theWidth,
		int &	theHeight,
		int &	theWidthMax,
		int &	theHeightMax )

pure virtual

Read offscreen FBO configuration.

Implemented in OpenGl_View.

◆ FBORelease()

virtual void Graphic3d_CView::FBORelease ( occ::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 ( )

inlinevirtual

Displays Graduated Trihedron.

◆ 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 )

inlinevirtual

Displays Graduated Trihedron.

Reimplemented in OpenGl_View.

◆ GraduatedTrihedronErase()

virtual void Graphic3d_CView::GraduatedTrihedronErase ( )

inlinevirtual

Erases Graduated Trihedron.

Reimplemented in OpenGl_View.

◆ GraduatedTrihedronMinMaxValues()

virtual void Graphic3d_CView::GraduatedTrihedronMinMaxValues	(	const NCollection_Vec3< float >	theMin,
		const NCollection_Vec3< float >	theMax )

inlinevirtual

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

Parameters

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

Reimplemented in OpenGl_View.

◆ GridDisplay()

virtual void Graphic3d_CView::GridDisplay	(	const Aspect_GridParams &	theParams,
		const gp_Ax3 &	thePlane )

inlinevirtual

Display a shader-rendered grid on the given plane. The default implementation is a no-op; drivers with shader support override it.

Parameters

[in]	theParams	appearance parameters
[in]	thePlane	grid plane in world coordinates (origin + X/Y directions)

Reimplemented in OpenGl_View.

◆ GridErase()

virtual void Graphic3d_CView::GridErase ( )

inlinevirtual

Erase the shader-rendered grid. The default implementation is a no-op; drivers with shader support override it.

Reimplemented in OpenGl_View.

◆ IBLCubeMap()

const occ::handle< Graphic3d_CubeMap > & Graphic3d_CView::IBLCubeMap ( ) const

inline

Returns cubemap being set last time on background.

◆ Identification()

int Graphic3d_CView::Identification ( ) const

inline

Returns the identification number of the view.

◆ InitXR()

virtual bool Graphic3d_CView::InitXR ( )

virtual

Initialize XR session.

◆ InsertLayerAfter()

virtual void Graphic3d_CView::InsertLayerAfter	(	const Graphic3d_ZLayerId	theNewLayerId,
		const Graphic3d_ZLayerSettings &	theSettings,
		const Graphic3d_ZLayerId	theLayerBefore )

pure virtual

Add a layer to the view.

Parameters

[in]	theNewLayerId	id of new layer, should be > 0 (negative values are reserved for default layers).
[in]	theSettings	new layer settings
[in]	theLayerBefore	id of layer to append new layer after

Implemented in OpenGl_View.

◆ InsertLayerBefore()

virtual void Graphic3d_CView::InsertLayerBefore	(	const Graphic3d_ZLayerId	theNewLayerId,
		const Graphic3d_ZLayerSettings &	theSettings,
		const Graphic3d_ZLayerId	theLayerAfter )

pure virtual

Add a layer to the view.

Parameters

[in]	theNewLayerId	id of new layer, should be > 0 (negative values are reserved for default layers).
[in]	theSettings	new layer settings
[in]	theLayerAfter	id of layer to append new layer before

Implemented in OpenGl_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 )

virtual

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

◆ IsActive()

bool Graphic3d_CView::IsActive ( ) const

inline

Returns the activity flag of the view.

◆ IsActiveXR()

bool Graphic3d_CView::IsActiveXR ( ) const

Return TRUE if there is active XR session.

◆ IsComputed()

bool Graphic3d_CView::IsComputed	(	const int	theStructId,
		occ::handle< Graphic3d_Structure > &	theComputedStruct ) const

Returns 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 bool Graphic3d_CView::IsDefined ( ) const

pure virtual

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

Implemented in OpenGl_View.

◆ IsInvalidated()

virtual bool Graphic3d_CView::IsInvalidated ( )

pure virtual

Return true if view content cache has been invalidated.

Implemented in OpenGl_View.

◆ IsRemoved()

bool Graphic3d_CView::IsRemoved ( ) const

inline

Returns true if the view was removed.

◆ IsSubview()

bool Graphic3d_CView::IsSubview ( ) const

inline

list of child views

◆ IsSubviewComposer()

bool Graphic3d_CView::IsSubviewComposer ( ) const

inline

Return TRUE if this is view performs rendering of subviews and nothing else; FALSE by default. By default, view with subviews will render main scene and blit subviews on top of it. Rendering of main scene might become redundant in case if subviews cover entire window of parent view. This flag allows to disable rendering of the main scene in such scenarios without creation of a dedicated V3d_Viewer instance just for composing subviews.

◆ IsSubViewRelativeSize()

bool Graphic3d_CView::IsSubViewRelativeSize ( ) const

inline

Return TRUE if subview size is set as proportions relative to parent view.

◆ Layer()

virtual occ::handle< Graphic3d_Layer > Graphic3d_CView::Layer ( const Graphic3d_ZLayerId theLayerId ) const

pure virtual

Returns layer with given ID or NULL if undefined.

Implemented in OpenGl_View.

◆ Layers()

virtual const NCollection_List< occ::handle< Graphic3d_Layer > > & Graphic3d_CView::Layers ( ) const

pure virtual

Returns the list of layers.

Implemented in OpenGl_View.

◆ Lights()

virtual const occ::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 bool theToIncludeAuxiliary = 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

theToIncludeAuxiliary consider also auxiliary presentations (with infinite flag or with trihedron transformation persistence)

Returns: computed bounding box

Reimplemented in OpenGl_View.

◆ MinMaxValues() [2/2]

Bnd_Box Graphic3d_CView::MinMaxValues	(	const NCollection_Map< occ::handle< Graphic3d_Structure > > &	theSet,
		const bool	theToIncludeAuxiliary = 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 int Graphic3d_CView::NumberOfDisplayedStructures ( ) const

inlinevirtual

Returns number of displayed structures in the view.

◆ ParentView()

Graphic3d_CView * Graphic3d_CView::ParentView ( )

inline

Return parent View or NULL if this is not a subview.

◆ PosedXRCamera()

const occ::handle< Graphic3d_Camera > & Graphic3d_CView::PosedXRCamera ( ) const

inline

Returns transient XR camera position with tracked head orientation applied.

◆ PoseXRToWorld()

gp_Trsf Graphic3d_CView::PoseXRToWorld ( const gp_Trsf & thePoseXR ) const

inline

Convert XR pose to world space.

Parameters

[in] thePoseXR transformation defined in VR local coordinate system, oriented as Y-up, X-right and -Z-forward

Returns: transformation defining orientation of XR pose in world space

◆ ProcessXRInput()

virtual void Graphic3d_CView::ProcessXRInput ( )

virtual

Process input.

◆ ReCompute()

void Graphic3d_CView::ReCompute ( const occ::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 D3DHost_View, and OpenGl_View.

◆ RedrawImmediate()

virtual void Graphic3d_CView::RedrawImmediate ( )

pure virtual

Redraw immediate content of the view.

Implemented in D3DHost_View, and OpenGl_View.

◆ ReleaseXR()

virtual void Graphic3d_CView::ReleaseXR ( )

virtual

Release XR session.

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

◆ RemoveSubview()

bool Graphic3d_CView::RemoveSubview ( const Graphic3d_CView * theView )

Remove subview from the list.

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

◆ SetBackfacingModel()

void Graphic3d_CView::SetBackfacingModel ( const Graphic3d_TypeOfBackfacingModel theModel )

inline

Sets backfacing model for the view.

◆ SetBackground()

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

inlinevirtual

Sets background fill color.

◆ SetBackgroundImage()

virtual void Graphic3d_CView::SetBackgroundImage	(	const occ::handle< Graphic3d_TextureMap > &	theTextureMap,
		bool	theToUpdatePBREnv = true )

pure virtual

Sets image texture or environment cubemap as background.

Parameters

[in]	theTextureMap	source to set a background; should be either Graphic3d_Texture2D or Graphic3d_CubeMap
[in]	theToUpdatePBREnv	defines whether IBL maps will be generated or not (see GeneratePBREnvironment())

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.

◆ SetBackgroundSkydome()

void Graphic3d_CView::SetBackgroundSkydome	(	const Aspect_SkydomeBackground &	theAspect,
		bool	theToUpdatePBREnv = true )

Sets skydome aspect.

◆ SetBackgroundType()

void Graphic3d_CView::SetBackgroundType ( Graphic3d_TypeOfBackground theType )

inline

Sets background type.

◆ SetBaseXRCamera()

void Graphic3d_CView::SetBaseXRCamera ( const occ::handle< Graphic3d_Camera > & theCamera )

inline

Sets anchor camera definition.

◆ SetCamera()

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

inlinevirtual

Sets camera used by the view.

◆ SetClipPlanes()

virtual void Graphic3d_CView::SetClipPlanes ( const occ::handle< Graphic3d_SequenceOfHClipPlane > & thePlanes )

pure virtual

Sets list of clip planes for the view.

Implemented in OpenGl_View.

◆ SetComputedMode()

void Graphic3d_CView::SetComputedMode ( const bool theMode )

Switches computed HLR mode in the view.

◆ SetFBO()

virtual void Graphic3d_CView::SetFBO ( const occ::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.

◆ SetImageBasedLighting()

virtual void Graphic3d_CView::SetImageBasedLighting ( bool theToEnableIBL )

pure virtual

Enables or disables IBL (Image Based Lighting) from background cubemap. Has no effect if PBR is not used.

Parameters

[in] theToEnableIBL enable or disable IBL from background cubemap

Implemented in OpenGl_View.

◆ SetImmediateModeDrawToFront()

virtual bool Graphic3d_CView::SetImmediateModeDrawToFront ( const bool 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.

◆ SetLights()

virtual void Graphic3d_CView::SetLights ( const occ::handle< Graphic3d_LightSet > & theLights )

pure virtual

Sets list of lights for the view.

Implemented in OpenGl_View.

◆ SetPosedXRCamera()

void Graphic3d_CView::SetPosedXRCamera ( const occ::handle< Graphic3d_Camera > & theCamera )

inline

Sets transient XR camera position with tracked head orientation applied.

◆ SetShadingModel()

void Graphic3d_CView::SetShadingModel ( Graphic3d_TypeOfShadingModel theModel )

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

◆ SetSubviewComposer()

void Graphic3d_CView::SetSubviewComposer ( bool theIsComposer )

inline

Set if this view should perform composing of subviews and nothing else.

◆ SetSubviewCorner()

void Graphic3d_CView::SetSubviewCorner ( Aspect_TypeOfTriedronPosition thePos )

inline

Set subview position within parent view.

◆ SetSubviewMargins()

void Graphic3d_CView::SetSubviewMargins ( const NCollection_Vec2< int > & theMargins )

inline

Set subview margins in pixels.

◆ SetSubviewOffset()

void Graphic3d_CView::SetSubviewOffset ( const NCollection_Vec2< double > & theOffset )

inline

Set corner offset within parent view.

◆ SetSubviewSize()

void Graphic3d_CView::SetSubviewSize ( const NCollection_Vec2< double > & theSize )

inline

Set subview size relative to parent view.

◆ SetTextureEnv()

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

pure virtual

Sets environment texture for the view.

Implemented in OpenGl_View.

◆ SetToFlipOutput()

virtual void Graphic3d_CView::SetToFlipOutput ( const bool )

inlinevirtual

Sets state of flip OY necessity in projection matrix.

Reimplemented in OpenGl_View.

◆ SetUnitFactor()

void Graphic3d_CView::SetUnitFactor ( double theFactor )

Set unit scale factor.

◆ SetupXRPosedCamera()

void Graphic3d_CView::SetupXRPosedCamera ( )

Compute PosedXRCamera() based on current XR head pose and make it active.

◆ SetVisualizationType()

void Graphic3d_CView::SetVisualizationType ( const Graphic3d_TypeOfVisualization theType )

inline

Sets visualization type of the view.

◆ SetWindow()

virtual void Graphic3d_CView::SetWindow	(	const occ::handle< Graphic3d_CView > &	theParentVIew,
		const occ::handle< Aspect_Window > &	theWindow,
		const Aspect_RenderingContext	theContext )

pure virtual

Creates and maps rendering window to the view.

Parameters

[in]	theParentVIew	parent view or NULL
[in]	theWindow	the window
[in]	theContext	the rendering context; if NULL the context will be created internally

Implemented in D3DHost_View, and OpenGl_View.

◆ SetXRSession()

void Graphic3d_CView::SetXRSession ( const occ::handle< Aspect_XRSession > & theSession )

inline

Set XR session.

◆ SetZLayerRedrawMode()

void Graphic3d_CView::SetZLayerRedrawMode ( const bool theMode )

inline

Sets ZLayerId redraw mode.

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

◆ SetZLayerTarget()

void Graphic3d_CView::SetZLayerTarget ( const Graphic3d_ZLayerId theTarget )

inline

Sets ZLayerId target.

◆ ShadingModel()

Graphic3d_TypeOfShadingModel Graphic3d_CView::ShadingModel ( ) const

inline

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

◆ ShadowMapDump()

virtual bool Graphic3d_CView::ShadowMapDump	(	Image_PixMap &	theImage,
		const TCollection_AsciiString &	theLightName )

pure virtual

Dumps the graphical contents of a shadowmap framebuffer into an image.

Parameters

	theImage	the image to store the shadow map.
[in]	theLightName	name of the light used to generate the shadow map.

Implemented in OpenGl_View.

◆ 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 ( NCollection_IndexedDataMap< TCollection_AsciiString, TCollection_AsciiString > & theDict ) const

pure virtual

Fills in the dictionary with statistic performance info.

Implemented in OpenGl_View.

◆ StructureManager()

const occ::handle< Graphic3d_StructureManager > & Graphic3d_CView::StructureManager ( ) const

inline

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

◆ SubviewCorner()

Aspect_TypeOfTriedronPosition Graphic3d_CView::SubviewCorner ( ) const

inline

Return subview position within parent view; Aspect_TOTP_LEFT_UPPER by default.

◆ SubviewMargins()

const NCollection_Vec2< int > & Graphic3d_CView::SubviewMargins ( ) const

inline

Return subview margins in pixels; (0,0) by default.

◆ SubviewOffset()

const NCollection_Vec2< double > & Graphic3d_CView::SubviewOffset ( ) const

inline

Return corner offset within parent view; (0.0,0.0) by default. Values >= 2 define offset in pixels; Values <= 1.0 define offset as fraction of parent view dimensions.

◆ SubviewResized()

void Graphic3d_CView::SubviewResized ( const occ::handle< Aspect_NeutralWindow > & theWindow )

Update subview position and dimensions.

◆ Subviews()

const NCollection_Sequence< occ::handle< Graphic3d_CView > > & Graphic3d_CView::Subviews ( ) const

inline

Return subview list.

◆ SubviewSize()

const NCollection_Vec2< double > & Graphic3d_CView::SubviewSize ( ) const

inline

Return subview dimensions; (1.0, 1.0) by default. Values >= 2 define size in pixels; Values <= 1.0 define size as fraction of parent view.

◆ SubviewTopLeft()

const NCollection_Vec2< int > & Graphic3d_CView::SubviewTopLeft ( ) const

inline

Return subview top-left position relative to parent view in pixels.

◆ SynchronizeXRBaseToPosedCamera()

void Graphic3d_CView::SynchronizeXRBaseToPosedCamera ( )

Recomputes PosedXRCamera() based on BaseXRCamera() and head orientation.

◆ SynchronizeXRPosedToBaseCamera()

void Graphic3d_CView::SynchronizeXRPosedToBaseCamera ( )

Checks if PosedXRCamera() has been modified since SetupXRPosedCamera() and copies these modifications to BaseXRCamera().

◆ TextureEnv()

const occ::handle< Graphic3d_TextureEnv > & Graphic3d_CView::TextureEnv ( ) const

inline

Returns environment texture set for the view.

◆ ToFlipOutput()

virtual bool Graphic3d_CView::ToFlipOutput ( ) const

inlinevirtual

Returns necessity to flip OY in projection matrix.

Reimplemented in OpenGl_View.

◆ TurnViewXRCamera()

void Graphic3d_CView::TurnViewXRCamera ( const gp_Trsf & theTrsfTurn )

Turn XR camera direction using current (head) eye position as anchor.

◆ UnitFactor()

double Graphic3d_CView::UnitFactor ( ) const

inline

Return unit scale factor defined as scale factor for m (meters); 1.0 by default. Normally, view definition is unitless, however some operations like VR input requires proper units mapping.

◆ UnsetXRPosedCamera()

void Graphic3d_CView::UnsetXRPosedCamera ( )

Set current camera back to BaseXRCamera() and copy temporary modifications of PosedXRCamera(). Calls SynchronizeXRPosedToBaseCamera() beforehand.

◆ Update()

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

Invalidates bounding box of specified ZLayerId.

◆ ViewAxisInWorld()

gp_Ax1 Graphic3d_CView::ViewAxisInWorld ( const gp_Trsf & thePoseXR ) const

inline

Returns view direction in the world space based on XR pose.

Parameters

[in] thePoseXR transformation defined in VR local coordinate system, oriented as Y-up, X-right and -Z-forward

◆ VisualizationType()

Graphic3d_TypeOfVisualization Graphic3d_CView::VisualizationType ( ) const

inline

Returns visualization type of the view.

◆ Window()

virtual occ::handle< Aspect_Window > Graphic3d_CView::Window ( ) const

pure virtual

Returns the window associated to the view.

Implemented in OpenGl_View.

◆ XRSession()

const occ::handle< Aspect_XRSession > & Graphic3d_CView::XRSession ( ) const

inline

Return XR session.

◆ ZLayerMax()

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

◆ ZLayerRedrawMode()

bool Graphic3d_CView::ZLayerRedrawMode ( ) const

inline

Returns ZLayerId redraw mode.

◆ ZLayerTarget()

Graphic3d_ZLayerId Graphic3d_CView::ZLayerTarget ( ) const

inline

Returns ZLayerId target.

Field Documentation

◆ myBackfacing

Graphic3d_TypeOfBackfacingModel Graphic3d_CView::myBackfacing

protected

list of child views

◆ myBackgroundImage

occ::handle<Graphic3d_TextureMap> Graphic3d_CView::myBackgroundImage

protected

list of child views

◆ myBackgroundType

Graphic3d_TypeOfBackground Graphic3d_CView::myBackgroundType

protected

Current type of background.

◆ myBackXRCamera

occ::handle<Graphic3d_Camera> Graphic3d_CView::myBackXRCamera

protected

camera projection parameters to restore after closing XR session (FOV, aspect and similar)

◆ myBaseXRCamera

occ::handle<Graphic3d_Camera> Graphic3d_CView::myBaseXRCamera

protected

neutral camera orientation defining coordinate system in which head tracking is defined

◆ myBgColor

Quantity_ColorRGBA Graphic3d_CView::myBgColor

protected

list of child views

◆ myCamera

occ::handle<Graphic3d_Camera> Graphic3d_CView::myCamera

protected

list of child views

◆ myCubeMapBackground

occ::handle<Graphic3d_CubeMap> Graphic3d_CView::myCubeMapBackground

protected

Cubemap displayed at background.

◆ myCubeMapIBL

occ::handle<Graphic3d_CubeMap> Graphic3d_CView::myCubeMapIBL

protected

Cubemap used for environment lighting.

◆ myGTrihedronData

Graphic3d_GraduatedTrihedron Graphic3d_CView::myGTrihedronData

protected

list of child views

◆ myId

int Graphic3d_CView::myId

protected

list of child views

◆ myIsActive

bool Graphic3d_CView::myIsActive

protected

list of child views

◆ myIsInComputedMode

bool Graphic3d_CView::myIsInComputedMode

protected

list of child views

◆ myIsRemoved

bool Graphic3d_CView::myIsRemoved

protected

list of child views

◆ myIsSubviewComposer

bool Graphic3d_CView::myIsSubviewComposer

protected

flag to skip rendering of viewer contents

◆ myParentView

Graphic3d_CView* Graphic3d_CView::myParentView

protected

back-pointer to the parent view

◆ myPosedXRCamera

occ::handle<Graphic3d_Camera> Graphic3d_CView::myPosedXRCamera

protected

transient XR camera orientation with tracked head orientation applied (based on myBaseXRCamera)

◆ myPosedXRCameraCopy

occ::handle<Graphic3d_Camera> Graphic3d_CView::myPosedXRCameraCopy

protected

neutral camera orientation copy at the beginning of processing input

◆ myRenderParams

Graphic3d_RenderingParams Graphic3d_CView::myRenderParams

protected

list of child views

◆ mySkydomeAspect

Aspect_SkydomeBackground Graphic3d_CView::mySkydomeAspect

protected

list of child views

◆ myStructsComputed

NCollection_Sequence<occ::handle<Graphic3d_Structure> > Graphic3d_CView::myStructsComputed

protected

list of child views

◆ myStructsDisplayed

NCollection_Map<occ::handle<Graphic3d_Structure> > Graphic3d_CView::myStructsDisplayed

protected

list of child views

◆ myStructsToCompute

NCollection_Sequence<occ::handle<Graphic3d_Structure> > Graphic3d_CView::myStructsToCompute

protected

list of child views

◆ myStructureManager

occ::handle<Graphic3d_StructureManager> Graphic3d_CView::myStructureManager

protected

list of child views

◆ mySubviewCorner

Aspect_TypeOfTriedronPosition Graphic3d_CView::mySubviewCorner

protected

position within parent view

◆ mySubviewMargins

NCollection_Vec2<int> Graphic3d_CView::mySubviewMargins

protected

subview margins in pixels

◆ mySubviewOffset

NCollection_Vec2<double> Graphic3d_CView::mySubviewOffset

protected

subview corner offset within parent view

◆ mySubviews

NCollection_Sequence<occ::handle<Graphic3d_CView> > Graphic3d_CView::mySubviews

protected

list of child views

◆ mySubviewSize

NCollection_Vec2<double> Graphic3d_CView::mySubviewSize

protected

subview size

◆ mySubviewTopLeft

NCollection_Vec2<int> Graphic3d_CView::mySubviewTopLeft

protected

subview top-left position relative to parent view

◆ myTextureEnvData

occ::handle<Graphic3d_TextureEnv> Graphic3d_CView::myTextureEnvData

protected

list of child views

◆ myToUpdateSkydome

bool Graphic3d_CView::myToUpdateSkydome

protected

list of child views

◆ myUnitFactor

double Graphic3d_CView::myUnitFactor

protected

unit scale factor defined as scale factor for m (meters)

◆ myVisualization

Graphic3d_TypeOfVisualization Graphic3d_CView::myVisualization

protected

list of child views

◆ myXRSession

occ::handle<Aspect_XRSession> Graphic3d_CView::myXRSession

protected

list of child views

◆ myZLayerRedrawMode

bool Graphic3d_CView::myZLayerRedrawMode

protected

If true redraws single layer, otherwise redraws group of layers.

◆ myZLayerTarget

Graphic3d_ZLayerId Graphic3d_CView::myZLayerTarget

protected

ZLayerId for redrawing the content of specific zlayers.

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

Graphic3d_CView.hxx

Public Member Functions

subview properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Graphic3d_CView()

◆ ~Graphic3d_CView()

Member Function Documentation

◆ Activate()

◆ AddSubview()

◆ BackfacingModel()

◆ Background()

◆ BackgroundCubeMap()

◆ BackgroundImage()

◆ BackgroundImageStyle()

◆ BackgroundSkydome()

◆ BackgroundType()

◆ BaseXRCamera()

◆ BufferDump()

◆ Camera()

◆ ChangeRenderingParams()

◆ ClipPlanes()

◆ Compute()

◆ ComputedMode()

◆ ComputeXRBaseCameraFromPosed()

◆ ComputeXRPosedCameraFromBase()

◆ ConsiderZoomPersistenceObjects()

◆ CopySettings()

◆ Deactivate()

◆ DiagnosticInformation()

◆ DisplayedStructures()

◆ DumpJson()

◆ FBO()

◆ FBOChangeViewport()

◆ FBOCreate()

◆ FBOGetDimensions()

◆ FBORelease()

◆ GetGraduatedTrihedron()

◆ GradientBackground()

◆ GraduatedTrihedronDisplay()

◆ GraduatedTrihedronErase()

◆ GraduatedTrihedronMinMaxValues()

◆ GridDisplay()

◆ GridErase()

◆ IBLCubeMap()

◆ Identification()

◆ InitXR()

◆ InsertLayerAfter()

◆ InsertLayerBefore()

◆ Invalidate()

◆ InvalidateBVHData()

◆ InvalidateZLayerBoundingBox()

◆ IsActive()

◆ IsActiveXR()

◆ IsComputed()

◆ IsDefined()

◆ IsInvalidated()

◆ IsRemoved()

◆ IsSubview()

◆ IsSubviewComposer()

◆ IsSubViewRelativeSize()

◆ Layer()

◆ Layers()

◆ Lights()

◆ MinMaxValues() [1/2]

◆ MinMaxValues() [2/2]

◆ NumberOfDisplayedStructures()

◆ ParentView()

◆ PosedXRCamera()

◆ PoseXRToWorld()

◆ ProcessXRInput()

◆ ReCompute()

◆ Redraw()

◆ RedrawImmediate()

◆ ReleaseXR()

◆ Remove()

◆ RemoveSubview()

◆ RemoveZLayer()

◆ RenderingParams()

◆ Resized()