Open CASCADE Technology
7.7.0
|
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>
Public Member Functions | |
Graphic3d_CView (const Handle< Graphic3d_StructureManager > &theMgr) | |
Constructor. More... | |
virtual | ~Graphic3d_CView () |
Destructor. More... | |
Standard_Integer | Identification () const |
Returns the identification number of the view. More... | |
virtual void | Activate () |
Activates the view. Maps presentations defined within structure manager onto this view. More... | |
virtual void | Deactivate () |
Deactivates the view. Unmaps presentations defined within structure manager. The view in deactivated state will ignore actions on structures such as Display(). More... | |
Standard_Boolean | IsActive () const |
Returns the activity flag of the view. More... | |
virtual void | Remove () |
Erases the view and removes from graphic driver. No more graphic operations are allowed in this view after the call. More... | |
Standard_Boolean | IsRemoved () const |
Returns true if the view was removed. More... | |
virtual const Handle< Graphic3d_Camera > & | Camera () const override |
Returns camera object of the view. More... | |
virtual void | SetCamera (const Handle< Graphic3d_Camera > &theCamera) |
Sets camera used by the view. More... | |
Graphic3d_TypeOfShadingModel | ShadingModel () const |
Returns default Shading Model of the view; Graphic3d_TypeOfShadingModel_Phong by default. More... | |
void | SetShadingModel (Graphic3d_TypeOfShadingModel theModel) |
Sets default Shading Model of the view. Will throw an exception on attempt to set Graphic3d_TypeOfShadingModel_DEFAULT. More... | |
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. More... | |
void | SetBackfacingModel (const Graphic3d_TypeOfBackfacingModel theModel) |
Sets backfacing model for the view. More... | |
Graphic3d_TypeOfVisualization | VisualizationType () const |
Returns visualization type of the view. More... | |
void | SetVisualizationType (const Graphic3d_TypeOfVisualization theType) |
Sets visualization type of the view. More... | |
void | SetComputedMode (const Standard_Boolean theMode) |
Switches computed HLR mode in the view. More... | |
Standard_Boolean | ComputedMode () const |
Returns the computed HLR mode state. More... | |
void | ReCompute (const Handle< Graphic3d_Structure > &theStructure) |
Computes the new presentation of the structure displayed in this view with the type Graphic3d_TOS_COMPUTED. More... | |
void | Update (const Graphic3d_ZLayerId theLayerId=Graphic3d_ZLayerId_UNKNOWN) |
Invalidates bounding box of specified ZLayerId. More... | |
void | Compute () |
Computes the new presentation of the structures displayed in this view with the type Graphic3d_TOS_COMPUTED. More... | |
void | DisplayedStructures (Graphic3d_MapOfStructure &theStructures) const |
Returns the set of structures displayed in this view. More... | |
virtual Standard_Integer | NumberOfDisplayedStructures () const |
Returns number of displayed structures in the view. More... | |
Standard_Boolean | IsComputed (const Standard_Integer theStructId, Handle< Graphic3d_Structure > &theComputedStruct) const |
Returns Standard_True in case if the structure with the given <theStructId> is in list of structures to be computed and stores computed struct to <theComputedStruct>. More... | |
virtual Bnd_Box | MinMaxValues (const Standard_Boolean theToIncludeAuxiliary=Standard_False) const |
Returns the bounding box of all structures displayed in the view. If theToIncludeAuxiliary is TRUE, then the boundary box also includes minimum and maximum limits of graphical elements forming parts of infinite and other auxiliary structures. More... | |
Bnd_Box | MinMaxValues (const Graphic3d_MapOfStructure &theSet, const Standard_Boolean theToIncludeAuxiliary=Standard_False) const |
Returns the coordinates of the boundary box of all structures in the set <theSet>. If <theToIgnoreInfiniteFlag> is TRUE, then the boundary box also includes minimum and maximum limits of graphical elements forming parts of infinite structures. More... | |
const Handle< Graphic3d_StructureManager > & | StructureManager () const |
Returns the structure manager handle which manage structures associated with this view. More... | |
virtual void | Redraw ()=0 |
Redraw content of the view. More... | |
virtual void | RedrawImmediate ()=0 |
Redraw immediate content of the view. More... | |
virtual void | Invalidate ()=0 |
Invalidates content of the view but does not redraw it. More... | |
virtual Standard_Boolean | IsInvalidated ()=0 |
Return true if view content cache has been invalidated. More... | |
virtual void | Resized ()=0 |
Handle changing size of the rendering window. More... | |
virtual Standard_Boolean | SetImmediateModeDrawToFront (const Standard_Boolean theDrawToFrontBuffer)=0 |
virtual void | SetWindow (const Handle< Graphic3d_CView > &theParentVIew, const Handle< Aspect_Window > &theWindow, const Aspect_RenderingContext theContext)=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 Standard_Boolean | BufferDump (Image_PixMap &theImage, const Graphic3d_BufferType &theBufferType)=0 |
Dump active rendering buffer into specified memory buffer. More... | |
virtual void | InvalidateBVHData (const Graphic3d_ZLayerId theLayerId)=0 |
Marks BVH tree and the set of BVH primitives of correspondent priority list with id theLayerId as outdated. More... | |
virtual void | InsertLayerBefore (const Graphic3d_ZLayerId theNewLayerId, const Graphic3d_ZLayerSettings &theSettings, const Graphic3d_ZLayerId theLayerAfter)=0 |
Add a layer to the view. More... | |
virtual void | InsertLayerAfter (const Graphic3d_ZLayerId theNewLayerId, const Graphic3d_ZLayerSettings &theSettings, const Graphic3d_ZLayerId theLayerBefore)=0 |
Add a layer to the view. More... | |
virtual Standard_Integer | ZLayerMax () const =0 |
Returns the maximum Z layer ID. First layer ID is Graphic3d_ZLayerId_Default, last ID is ZLayerMax(). More... | |
virtual const NCollection_List< Handle< Graphic3d_Layer > > & | Layers () const =0 |
Returns the list of layers. More... | |
virtual Handle< Graphic3d_Layer > | Layer (const Graphic3d_ZLayerId theLayerId) const =0 |
Returns layer with given ID or NULL if undefined. More... | |
virtual void | InvalidateZLayerBoundingBox (const Graphic3d_ZLayerId theLayerId) |
Returns the bounding box of all structures displayed in the Z layer. More... | |
virtual void | RemoveZLayer (const Graphic3d_ZLayerId theLayerId)=0 |
Remove Z layer from the specified view. All structures displayed at the moment in layer will be displayed in default layer ( the bottom-level z layer ). To unset layer ID from associated structures use method UnsetZLayer (...). More... | |
virtual void | SetZLayerSettings (const Graphic3d_ZLayerId theLayerId, const Graphic3d_ZLayerSettings &theSettings)=0 |
Sets the settings for a single Z layer of specified view. More... | |
Standard_Real | ConsiderZoomPersistenceObjects () |
Returns zoom-scale factor. More... | |
virtual Handle< Standard_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 Aspect_Background | Background () const |
Returns background fill color. More... | |
virtual void | SetBackground (const Aspect_Background &theBackground) |
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... | |
const Handle< Graphic3d_TextureMap > & | BackgroundImage () |
Returns background image texture map. More... | |
const Handle< Graphic3d_CubeMap > & | BackgroundCubeMap () const |
Returns cubemap being set last time on background. More... | |
const Handle< Graphic3d_CubeMap > & | IBLCubeMap () const |
Returns cubemap being set last time on background. More... | |
virtual void | SetBackgroundImage (const Handle< Graphic3d_TextureMap > &theTextureMap, Standard_Boolean theToUpdatePBREnv=Standard_True)=0 |
Sets image texture or environment cubemap as background. 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... | |
Graphic3d_TypeOfBackground | BackgroundType () const |
Returns background type. More... | |
void | SetBackgroundType (Graphic3d_TypeOfBackground theType) |
Sets background type. More... | |
const Aspect_SkydomeBackground & | BackgroundSkydome () const |
Returns skydome aspect;. More... | |
void | SetBackgroundSkydome (const Aspect_SkydomeBackground &theAspect, Standard_Boolean theToUpdatePBREnv=Standard_True) |
Sets skydome aspect. More... | |
virtual void | SetImageBasedLighting (Standard_Boolean theToEnableIBL)=0 |
Enables or disables IBL (Image Based Lighting) from background cubemap. Has no effect if PBR is not used. More... | |
const Handle< Graphic3d_TextureEnv > & | TextureEnv () const |
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 const Handle< Graphic3d_LightSet > & | Lights () const =0 |
Returns list of lights of the view. More... | |
virtual void | SetLights (const Handle< Graphic3d_LightSet > &theLights)=0 |
Sets list of lights for the view. More... | |
virtual const Handle< Graphic3d_SequenceOfHClipPlane > & | ClipPlanes () const =0 |
Returns list of clip planes set for the view. More... | |
virtual void | SetClipPlanes (const Handle< Graphic3d_SequenceOfHClipPlane > &thePlanes)=0 |
Sets list of clip planes for the view. More... | |
virtual void | DiagnosticInformation (TColStd_IndexedDataMapOfStringString &theDict, Graphic3d_DiagnosticInfo theFlags) const =0 |
Fill in the dictionary with diagnostic info. Should be called within rendering thread. More... | |
virtual TCollection_AsciiString | StatisticInformation () const =0 |
Returns string with statistic performance info. More... | |
virtual void | StatisticInformation (TColStd_IndexedDataMapOfStringString &theDict) const =0 |
Fills in the dictionary with statistic performance info. More... | |
Standard_Real | 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. More... | |
void | SetUnitFactor (Standard_Real theFactor) |
Set unit scale factor. More... | |
const Handle< Aspect_XRSession > & | XRSession () const |
Return XR session. More... | |
void | SetXRSession (const Handle< Aspect_XRSession > &theSession) |
Set XR session. More... | |
bool | IsActiveXR () const |
Return TRUE if there is active XR session. More... | |
virtual bool | InitXR () |
Initialize XR session. More... | |
virtual void | ReleaseXR () |
Release XR session. More... | |
virtual void | ProcessXRInput () |
Process input. More... | |
void | SetupXRPosedCamera () |
Compute PosedXRCamera() based on current XR head pose and make it active. More... | |
void | UnsetXRPosedCamera () |
Set current camera back to BaseXRCamera() and copy temporary modifications of PosedXRCamera(). Calls SynchronizeXRPosedToBaseCamera() beforehand. More... | |
const Handle< Graphic3d_Camera > & | PosedXRCamera () const |
Returns transient XR camera position with tracked head orientation applied. More... | |
void | SetPosedXRCamera (const Handle< Graphic3d_Camera > &theCamera) |
Sets transient XR camera position with tracked head orientation applied. More... | |
const Handle< Graphic3d_Camera > & | BaseXRCamera () const |
Returns anchor camera definition (without tracked head orientation). More... | |
void | SetBaseXRCamera (const Handle< Graphic3d_Camera > &theCamera) |
Sets anchor camera definition. More... | |
gp_Trsf | PoseXRToWorld (const gp_Trsf &thePoseXR) const |
Convert XR pose to world space. More... | |
gp_Ax1 | ViewAxisInWorld (const gp_Trsf &thePoseXR) const |
Returns view direction in the world space based on XR pose. More... | |
void | SynchronizeXRBaseToPosedCamera () |
Recomputes PosedXRCamera() based on BaseXRCamera() and head orientation. More... | |
void | SynchronizeXRPosedToBaseCamera () |
Checks if PosedXRCamera() has been modified since SetupXRPosedCamera() and copies these modifications to BaseXRCamera(). More... | |
void | ComputeXRPosedCameraFromBase (Graphic3d_Camera &theCam, const gp_Trsf &theXRTrsf) const |
Compute camera position based on XR pose. More... | |
void | ComputeXRBaseCameraFromPosed (const Graphic3d_Camera &theCamPosed, const gp_Trsf &thePoseTrsf) |
Update based camera from posed camera by applying reversed transformation. More... | |
void | TurnViewXRCamera (const gp_Trsf &theTrsfTurn) |
Turn XR camera direction using current (head) eye position as anchor. More... | |
obsolete Graduated Trihedron functionality | |
virtual const Graphic3d_GraduatedTrihedron & | GetGraduatedTrihedron () |
Returns data of a graduated trihedron. More... | |
virtual void | GraduatedTrihedronDisplay (const Graphic3d_GraduatedTrihedron &theTrihedronData) |
Displays Graduated Trihedron. More... | |
virtual void | GraduatedTrihedronErase () |
Erases Graduated Trihedron. More... | |
virtual void | GraduatedTrihedronMinMaxValues (const Graphic3d_Vec3 theMin, const Graphic3d_Vec3 theMax) |
Sets minimum and maximum points of scene bounding box for Graduated Trihedron stored in graphic view object. More... | |
virtual void | DumpJson (Standard_OStream &theOStream, Standard_Integer theDepth=-1) const override |
Dumps the content of me into the stream. 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 void | Delete () const |
Memory deallocator for transient classes. More... | |
virtual const opencascade::handle< Standard_Type > & | DynamicType () const |
Returns a type descriptor about this object. More... | |
Standard_Boolean | IsInstance (const opencascade::handle< Standard_Type > &theType) const |
Returns a true value if this is an instance of Type. More... | |
Standard_Boolean | IsInstance (const Standard_CString theTypeName) const |
Returns a true value if this is an instance of TypeName. More... | |
Standard_Boolean | IsKind (const opencascade::handle< Standard_Type > &theType) const |
Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism. More... | |
Standard_Boolean | IsKind (const Standard_CString theTypeName) const |
Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism. More... | |
Standard_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... | |
subview properties | |
Standard_Integer | myId |
list of child views More... | |
Graphic3d_RenderingParams | myRenderParams |
list of child views More... | |
NCollection_Sequence< Handle< Graphic3d_CView > > | mySubviews |
list of child views More... | |
Graphic3d_CView * | myParentView |
back-pointer to the parent view More... | |
Standard_Boolean | myIsSubviewComposer |
flag to skip rendering of viewer contents More... | |
Aspect_TypeOfTriedronPosition | mySubviewCorner |
position within parent view More... | |
Graphic3d_Vec2i | mySubviewTopLeft |
subview top-left position relative to parent view More... | |
Graphic3d_Vec2i | mySubviewMargins |
subview margins in pixels More... | |
Graphic3d_Vec2d | mySubviewSize |
subview size More... | |
Graphic3d_Vec2d | mySubviewOffset |
subview corner offset within parent view More... | |
Handle< Graphic3d_StructureManager > | myStructureManager |
list of child views More... | |
Handle< Graphic3d_Camera > | myCamera |
list of child views More... | |
Graphic3d_SequenceOfStructure | myStructsToCompute |
list of child views More... | |
Graphic3d_SequenceOfStructure | myStructsComputed |
list of child views More... | |
Graphic3d_MapOfStructure | myStructsDisplayed |
list of child views More... | |
Standard_Boolean | myIsInComputedMode |
list of child views More... | |
Standard_Boolean | myIsActive |
list of child views More... | |
Standard_Boolean | myIsRemoved |
list of child views More... | |
Graphic3d_TypeOfBackfacingModel | myBackfacing |
list of child views More... | |
Graphic3d_TypeOfVisualization | myVisualization |
list of child views More... | |
Quantity_ColorRGBA | myBgColor |
list of child views More... | |
Handle< Graphic3d_TextureMap > | myBackgroundImage |
list of child views More... | |
Handle< Graphic3d_CubeMap > | myCubeMapBackground |
Cubemap displayed at background. More... | |
Handle< Graphic3d_CubeMap > | myCubeMapIBL |
Cubemap used for environment lighting. More... | |
Handle< Graphic3d_TextureEnv > | myTextureEnvData |
list of child views More... | |
Graphic3d_GraduatedTrihedron | myGTrihedronData |
list of child views More... | |
Graphic3d_TypeOfBackground | myBackgroundType |
Current type of background. More... | |
Aspect_SkydomeBackground | mySkydomeAspect |
list of child views More... | |
Standard_Boolean | myToUpdateSkydome |
list of child views More... | |
Handle< Aspect_XRSession > | myXRSession |
list of child views More... | |
Handle< Graphic3d_Camera > | myBackXRCamera |
camera projection parameters to restore after closing XR session (FOV, aspect and similar) More... | |
Handle< Graphic3d_Camera > | myBaseXRCamera |
neutral camera orientation defining coordinate system in which head tracking is defined More... | |
Handle< Graphic3d_Camera > | myPosedXRCamera |
transient XR camera orientation with tracked head orientation applied (based on myBaseXRCamera) More... | |
Handle< Graphic3d_Camera > | myPosedXRCameraCopy |
neutral camera orientation copy at the beginning of processing input More... | |
Standard_Real | myUnitFactor |
unit scale factor defined as scale factor for m (meters) More... | |
bool | IsSubview () const |
Return TRUE if this is a subview of another view. More... | |
Graphic3d_CView * | ParentView () |
Return parent View or NULL if this is not a subview. More... | |
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. More... | |
void | SetSubviewComposer (bool theIsComposer) |
Set if this view should perform composing of subviews and nothing else. More... | |
const NCollection_Sequence< Handle< Graphic3d_CView > > & | Subviews () const |
Return subview list. More... | |
void | AddSubview (const Handle< Graphic3d_CView > &theView) |
Add subview to the list. More... | |
bool | RemoveSubview (const Graphic3d_CView *theView) |
Remove subview from the list. More... | |
Aspect_TypeOfTriedronPosition | SubviewCorner () const |
Return subview position within parent view; Aspect_TOTP_LEFT_UPPER by default. More... | |
void | SetSubviewCorner (Aspect_TypeOfTriedronPosition thePos) |
Set subview position within parent view. More... | |
const Graphic3d_Vec2i & | SubviewTopLeft () const |
Return subview top-left position relative to parent view in pixels. More... | |
bool | IsSubViewRelativeSize () const |
Return TRUE if subview size is set as proportions relative to parent view. More... | |
const Graphic3d_Vec2d & | 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. More... | |
void | SetSubviewSize (const Graphic3d_Vec2d &theSize) |
Set subview size relative to parent view. More... | |
const Graphic3d_Vec2d & | 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. More... | |
void | SetSubviewOffset (const Graphic3d_Vec2d &theOffset) |
Set corner offset within parent view. More... | |
const Graphic3d_Vec2i & | SubviewMargins () const |
Return subview margins in pixels; (0,0) by default. More... | |
void | SetSubviewMargins (const Graphic3d_Vec2i &theMargins) |
Set subview margins in pixels. More... | |
void | SubviewResized (const Handle< Aspect_NeutralWindow > &theWindow) |
Update subview position and dimensions. 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... | |
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.
Graphic3d_CView::Graphic3d_CView | ( | const Handle< Graphic3d_StructureManager > & | theMgr | ) |
Constructor.
|
virtual |
Destructor.
|
virtual |
Activates the view. Maps presentations defined within structure manager onto this view.
void Graphic3d_CView::AddSubview | ( | const Handle< Graphic3d_CView > & | theView | ) |
Add subview to the list.
|
inline |
Return backfacing model used for the view; Graphic3d_TypeOfBackfacingModel_Auto by default, which means that backface culling is defined by each presentation.
|
inlinevirtual |
Returns background fill color.
|
inline |
Returns cubemap being set last time on background.
|
inline |
Returns background image texture map.
|
pure virtual |
Returns background image fill style.
Implemented in OpenGl_View.
|
inline |
Returns skydome aspect;.
|
inline |
Returns background type.
|
inline |
Returns anchor camera definition (without tracked head orientation).
|
pure virtual |
Dump active rendering buffer into specified memory buffer.
Implemented in OpenGl_View.
|
inlineoverridevirtual |
Returns camera object of the view.
Implements Graphic3d_DataStructureManager.
|
inline |
Returns reference to current rendering parameters and effect settings.
|
pure virtual |
Returns list of clip planes set for the view.
Implemented in OpenGl_View.
void Graphic3d_CView::Compute | ( | ) |
Computes the new presentation of the structures displayed in this view with the type Graphic3d_TOS_COMPUTED.
|
inline |
Returns the computed HLR mode state.
void Graphic3d_CView::ComputeXRBaseCameraFromPosed | ( | const Graphic3d_Camera & | theCamPosed, |
const gp_Trsf & | thePoseTrsf | ||
) |
Update based camera from posed camera by applying reversed transformation.
void Graphic3d_CView::ComputeXRPosedCameraFromBase | ( | Graphic3d_Camera & | theCam, |
const gp_Trsf & | theXRTrsf | ||
) | const |
Compute camera position based on XR pose.
Standard_Real Graphic3d_CView::ConsiderZoomPersistenceObjects | ( | ) |
Returns zoom-scale factor.
|
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 |
Deactivates the view. Unmaps presentations defined within structure manager. The view in deactivated state will ignore actions on structures such as Display().
|
pure virtual |
Fill in the dictionary with diagnostic info. Should be called within rendering thread.
This API should be used only for user output or for creating automated reports. The format of returned information (e.g. key-value layout) is NOT part of this API and can be changed at any time. Thus application should not parse returned information to weed out specific parameters.
Implemented in OpenGl_View, and D3DHost_View.
void Graphic3d_CView::DisplayedStructures | ( | Graphic3d_MapOfStructure & | theStructures | ) | const |
Returns the set of structures displayed in this view.
|
overridevirtual |
Dumps the content of me into the stream.
Reimplemented from Graphic3d_DataStructureManager.
|
pure virtual |
Returns pointer to an assigned framebuffer object.
Implemented in OpenGl_View.
|
pure virtual |
Change offscreen FBO viewport.
Implemented in OpenGl_View.
|
pure virtual |
Generate offscreen FBO in the graphic library. If not supported on hardware returns NULL.
Implemented in OpenGl_View.
|
pure virtual |
Read offscreen FBO configuration.
Implemented in OpenGl_View.
|
pure virtual |
Remove offscreen FBO from the graphic library.
Implemented in OpenGl_View.
|
inlinevirtual |
Returns data of a graduated trihedron.
|
pure virtual |
Returns gradient background fill colors.
Implemented in OpenGl_View.
|
inlinevirtual |
Displays Graduated Trihedron.
Reimplemented in OpenGl_View.
|
inlinevirtual |
Erases Graduated Trihedron.
Reimplemented in OpenGl_View.
|
inlinevirtual |
Sets minimum and maximum points of scene bounding box for Graduated Trihedron stored in graphic view object.
theMin | [in] the minimum point of scene. |
theMax | [in] the maximum point of scene. |
Reimplemented in OpenGl_View.
|
inline |
Returns cubemap being set last time on background.
|
inline |
Returns the identification number of the view.
|
virtual |
Initialize XR session.
|
pure virtual |
Add a layer to the view.
theNewLayerId | [in] id of new layer, should be > 0 (negative values are reserved for default layers). |
theSettings | [in] new layer settings |
theLayerBefore | [in] id of layer to append new layer after |
Implemented in OpenGl_View.
|
pure virtual |
Add a layer to the view.
theNewLayerId | [in] id of new layer, should be > 0 (negative values are reserved for default layers). |
theSettings | [in] new layer settings |
theLayerAfter | [in] id of layer to append new layer before |
Implemented in OpenGl_View.
|
pure virtual |
Invalidates content of the view but does not redraw it.
Implemented in OpenGl_View.
|
pure virtual |
Marks BVH tree and the set of BVH primitives of correspondent priority list with id theLayerId as outdated.
Implemented in OpenGl_View.
|
virtual |
Returns the bounding box of all structures displayed in the Z layer.
|
inline |
Returns the activity flag of the view.
bool Graphic3d_CView::IsActiveXR | ( | ) | const |
Return TRUE if there is active XR session.
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>.
|
pure virtual |
Returns True if the window associated to the view is defined.
Implemented in OpenGl_View.
|
pure virtual |
Return true if view content cache has been invalidated.
Implemented in OpenGl_View.
|
inline |
Returns true if the view was removed.
|
inline |
Return TRUE if this is a subview of another view.
|
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.
|
inline |
Return TRUE if subview size is set as proportions relative to parent view.
|
pure virtual |
Returns layer with given ID or NULL if undefined.
Implemented in OpenGl_View.
|
pure virtual |
Returns the list of layers.
Implemented in OpenGl_View.
|
pure virtual |
Returns list of lights of the view.
Implemented in OpenGl_View.
|
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.
theToIncludeAuxiliary | consider also auxiliary presentations (with infinite flag or with trihedron transformation persistence) |
Reimplemented in OpenGl_View.
Bnd_Box Graphic3d_CView::MinMaxValues | ( | const Graphic3d_MapOfStructure & | theSet, |
const Standard_Boolean | theToIncludeAuxiliary = Standard_False |
||
) | const |
Returns the coordinates of the boundary box of all structures in the set <theSet>. If <theToIgnoreInfiniteFlag> is TRUE, then the boundary box also includes minimum and maximum limits of graphical elements forming parts of infinite structures.
|
inlinevirtual |
Returns number of displayed structures in the view.
|
inline |
Return parent View or NULL if this is not a subview.
|
inline |
Returns transient XR camera position with tracked head orientation applied.
Convert XR pose to world space.
thePoseXR | [in] transformation defined in VR local coordinate system, oriented as Y-up, X-right and -Z-forward |
|
virtual |
Process input.
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.
|
pure virtual |
Redraw content of the view.
Implemented in OpenGl_View, and D3DHost_View.
|
pure virtual |
Redraw immediate content of the view.
Implemented in OpenGl_View, and D3DHost_View.
|
virtual |
Release XR session.
|
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.
bool Graphic3d_CView::RemoveSubview | ( | const Graphic3d_CView * | theView | ) |
Remove subview from the list.
|
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.
|
inline |
Returns current rendering parameters and effect settings.
|
pure virtual |
Handle changing size of the rendering window.
Implemented in OpenGl_View, and D3DHost_View.
|
inline |
Sets backfacing model for the view.
|
inlinevirtual |
Sets background fill color.
|
pure virtual |
Sets image texture or environment cubemap as background.
theTextureMap | [in] source to set a background; should be either Graphic3d_Texture2D or Graphic3d_CubeMap |
theToUpdatePBREnv | [in] defines whether IBL maps will be generated or not (see GeneratePBREnvironment()) |
Implemented in OpenGl_View.
|
pure virtual |
Sets background image fill style.
Implemented in OpenGl_View.
void Graphic3d_CView::SetBackgroundSkydome | ( | const Aspect_SkydomeBackground & | theAspect, |
Standard_Boolean | theToUpdatePBREnv = Standard_True |
||
) |
Sets skydome aspect.
|
inline |
Sets background type.
|
inline |
Sets anchor camera definition.
|
inlinevirtual |
Sets camera used by the view.
|
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.
|
pure virtual |
Sets framebuffer object for offscreen rendering.
Implemented in OpenGl_View.
|
pure virtual |
Sets gradient background fill colors.
Implemented in OpenGl_View.
|
pure virtual |
Enables or disables IBL (Image Based Lighting) from background cubemap. Has no effect if PBR is not used.
[in] | theToEnableIBL | enable or disable IBL from background cubemap |
Implemented in OpenGl_View.
|
pure virtual |
theDrawToFrontBuffer | Advanced option to modify rendering mode:
|
Implemented in OpenGl_View.
|
pure virtual |
Sets list of lights for the view.
Implemented in OpenGl_View.
|
inline |
Sets transient XR camera position with tracked head orientation applied.
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.
|
inline |
Set if this view should perform composing of subviews and nothing else.
|
inline |
Set subview position within parent view.
|
inline |
Set subview margins in pixels.
|
inline |
Set corner offset within parent view.
|
inline |
Set subview size relative to parent view.
|
pure virtual |
Sets environment texture for the view.
Implemented in OpenGl_View.
void Graphic3d_CView::SetUnitFactor | ( | Standard_Real | theFactor | ) |
Set unit scale factor.
void Graphic3d_CView::SetupXRPosedCamera | ( | ) |
Compute PosedXRCamera() based on current XR head pose and make it active.
|
inline |
Sets visualization type of the view.
|
pure virtual |
Creates and maps rendering window to the view.
[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 OpenGl_View, and D3DHost_View.
|
inline |
Set XR session.
|
pure virtual |
Sets the settings for a single Z layer of specified view.
Implemented in OpenGl_View.
|
inline |
Returns default Shading Model of the view; Graphic3d_TypeOfShadingModel_Phong by default.
|
pure virtual |
Returns string with statistic performance info.
Implemented in OpenGl_View.
|
pure virtual |
Fills in the dictionary with statistic performance info.
Implemented in OpenGl_View.
|
inline |
Returns the structure manager handle which manage structures associated with this view.
|
inline |
Return subview position within parent view; Aspect_TOTP_LEFT_UPPER by default.
|
inline |
Return subview margins in pixels; (0,0) by default.
|
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.
void Graphic3d_CView::SubviewResized | ( | const Handle< Aspect_NeutralWindow > & | theWindow | ) |
Update subview position and dimensions.
|
inline |
Return subview list.
|
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.
|
inline |
Return subview top-left position relative to parent view in pixels.
void Graphic3d_CView::SynchronizeXRBaseToPosedCamera | ( | ) |
Recomputes PosedXRCamera() based on BaseXRCamera() and head orientation.
void Graphic3d_CView::SynchronizeXRPosedToBaseCamera | ( | ) |
Checks if PosedXRCamera() has been modified since SetupXRPosedCamera() and copies these modifications to BaseXRCamera().
|
inline |
Returns environment texture set for the view.
void Graphic3d_CView::TurnViewXRCamera | ( | const gp_Trsf & | theTrsfTurn | ) |
Turn XR camera direction using current (head) eye position as anchor.
|
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.
void Graphic3d_CView::UnsetXRPosedCamera | ( | ) |
Set current camera back to BaseXRCamera() and copy temporary modifications of PosedXRCamera(). Calls SynchronizeXRPosedToBaseCamera() beforehand.
void Graphic3d_CView::Update | ( | const Graphic3d_ZLayerId | theLayerId = Graphic3d_ZLayerId_UNKNOWN | ) |
Invalidates bounding box of specified ZLayerId.
Returns view direction in the world space based on XR pose.
thePoseXR | [in] transformation defined in VR local coordinate system, oriented as Y-up, X-right and -Z-forward |
|
inline |
Returns visualization type of the view.
|
pure virtual |
Returns the window associated to the view.
Implemented in OpenGl_View.
|
inline |
Return XR session.
|
pure virtual |
Returns the maximum Z layer ID. First layer ID is Graphic3d_ZLayerId_Default, last ID is ZLayerMax().
Implemented in OpenGl_View.
|
protected |
list of child views
|
protected |
list of child views
|
protected |
Current type of background.
|
protected |
camera projection parameters to restore after closing XR session (FOV, aspect and similar)
|
protected |
neutral camera orientation defining coordinate system in which head tracking is defined
|
protected |
list of child views
|
protected |
list of child views
|
protected |
Cubemap displayed at background.
|
protected |
Cubemap used for environment lighting.
|
protected |
list of child views
|
protected |
list of child views
|
protected |
list of child views
|
protected |
list of child views
|
protected |
list of child views
|
protected |
flag to skip rendering of viewer contents
|
protected |
back-pointer to the parent view
|
protected |
transient XR camera orientation with tracked head orientation applied (based on myBaseXRCamera)
|
protected |
neutral camera orientation copy at the beginning of processing input
|
protected |
list of child views
|
protected |
list of child views
|
protected |
list of child views
|
protected |
list of child views
|
protected |
list of child views
|
protected |
list of child views
|
protected |
position within parent view
|
protected |
subview margins in pixels
|
protected |
subview corner offset within parent view
|
protected |
list of child views
|
protected |
subview size
|
protected |
subview top-left position relative to parent view
|
protected |
list of child views
|
protected |
list of child views
|
protected |
unit scale factor defined as scale factor for m (meters)
|
protected |
list of child views
|
protected |
list of child views