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...
|
| 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_TOSM_FRAGMENT by default. More...
|
|
void | SetShadingModel (Graphic3d_TypeOfShadingModel theModel) |
| Sets default Shading Model of the view. Will throw an exception on attempt to set Graphic3d_TOSM_DEFAULT. More...
|
|
Graphic3d_TypeOfVisualization | VisualizationType () const |
| Returns visualization type of the view. More...
|
|
void | SetVisualizationType (const Graphic3d_TypeOfVisualization theType) |
| Sets visualization type of the view. More...
|
|
void | SetComputedMode (const Standard_Boolean theMode) |
| Switches computed HLR mode in the view. More...
|
|
Standard_Boolean | ComputedMode () const |
| Returns the computed HLR mode state. More...
|
|
void | ReCompute (const Handle< Graphic3d_Structure > &theStructure) |
| Computes the new presentation of the structure displayed in this view with the type Graphic3d_TOS_COMPUTED. More...
|
|
void | Update (const Graphic3d_ZLayerId theLayerId=Graphic3d_ZLayerId_UNKNOWN) |
| Invalidates bounding box of specified ZLayerId. More...
|
|
void | Compute () |
| Computes the new presentation of the structures displayed in this view with the type Graphic3d_TOS_COMPUTED. More...
|
|
Standard_Boolean | ContainsFacet () const |
| Returns Standard_True if one of the structures displayed in the view contains Polygons, Triangles or Quadrangles. More...
|
|
Standard_Boolean | ContainsFacet (const Graphic3d_MapOfStructure &theSet) const |
| Returns Standard_True if one of the structures in the set contains Polygons, Triangles or Quadrangles. More...
|
|
void | DisplayedStructures (Graphic3d_MapOfStructure &theStructures) const |
| Returns the set of structures displayed in this view. More...
|
|
virtual Standard_Integer | NumberOfDisplayedStructures () const |
| Returns number of displayed structures in the view. More...
|
|
const Handle< Graphic3d_NMapOfTransient > & | HiddenObjects () const |
| Returns map of objects hidden within this specific view (not viewer-wise). More...
|
|
Handle< Graphic3d_NMapOfTransient > & | ChangeHiddenObjects () |
| Returns map of objects hidden within this specific view (not viewer-wise). More...
|
|
Standard_Boolean | IsComputed (const Standard_Integer theStructId, Handle< Graphic3d_Structure > &theComputedStruct) const |
| Returns Standard_True in case if the structure with the given <theStructId> is in list of structures to be computed and stores computed struct to <theComputedStruct>. More...
|
|
virtual Bnd_Box | MinMaxValues (const Standard_Boolean theToIncludeAuxiliary=Standard_False) const |
| Returns the bounding box of all structures displayed in the view. If theToIncludeAuxiliary is TRUE, then the boundary box also includes minimum and maximum limits of graphical elements forming parts of infinite and other auxiliary structures. More...
|
|
Bnd_Box | MinMaxValues (const Graphic3d_MapOfStructure &theSet, const Standard_Boolean theToIncludeAuxiliary=Standard_False) const |
| Returns the coordinates of the boundary box of all structures in the set <theSet>. If <theToIgnoreInfiniteFlag> is TRUE, then the boundary box also includes minimum and maximum limits of graphical elements forming parts of infinite structures. More...
|
|
const Handle< Graphic3d_StructureManager > & | StructureManager () const |
| Returns the structure manager handle which manage structures associated with this view. More...
|
|
virtual void | Redraw ()=0 |
| Redraw content of the view. More...
|
|
virtual void | RedrawImmediate ()=0 |
| Redraw immediate content of the view. More...
|
|
virtual void | Invalidate ()=0 |
| Invalidates content of the view but does not redraw it. More...
|
|
virtual Standard_Boolean | IsInvalidated ()=0 |
| Return true if view content cache has been invalidated. More...
|
|
virtual void | Resized ()=0 |
| Handle changing size of the rendering window. More...
|
|
virtual Standard_Boolean | SetImmediateModeDrawToFront (const Standard_Boolean theDrawToFrontBuffer)=0 |
|
virtual void | SetWindow (const Handle< Aspect_Window > &theWindow, const Aspect_RenderingContext theContext=NULL)=0 |
| Creates and maps rendering window to the view. More...
|
|
virtual Handle< Aspect_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...
|
|
virtual Handle< Graphic3d_TextureMap > | BackgroundImage ()=0 |
| Returns background image texture map. More...
|
|
virtual void | SetBackgroundImage (const Handle< Graphic3d_TextureMap > &theTextureMap, Standard_Boolean theToUpdatePBREnv=Standard_True)=0 |
| Sets image texture or environment cubemap as backround. More...
|
|
virtual Aspect_FillMethod | BackgroundImageStyle () const =0 |
| Returns background image fill style. More...
|
|
virtual void | SetBackgroundImageStyle (const Aspect_FillMethod theFillStyle)=0 |
| Sets background image fill style. More...
|
|
virtual Handle< Graphic3d_CubeMap > | BackgroundCubeMap () const =0 |
| Returns cubemap being setted last time on background. More...
|
|
virtual void | GeneratePBREnvironment ()=0 |
| Generates PBR specular probe and irradiance map in order to provide environment indirect illumination in PBR shading model (Image Based Lighting). The source of environment data is background cubemap. If PBR is unavailable it does nothing. If PBR is available but there is no cubemap being set to background it clears all IBL maps (see 'ClearPBREnvironment'). More...
|
|
virtual void | ClearPBREnvironment ()=0 |
| Fills PBR specular probe and irradiance map with white color. So that environment indirect illumination will be constant and will be fully controlled by ambient light sources. If PBR is unavailable it does nothing. More...
|
|
virtual Handle< Graphic3d_TextureEnv > | TextureEnv () const =0 |
| Returns environment texture set for the view. More...
|
|
virtual void | SetTextureEnv (const Handle< Graphic3d_TextureEnv > &theTextureEnv)=0 |
| Sets environment texture for the view. More...
|
|
virtual Graphic3d_TypeOfBackfacingModel | BackfacingModel () const =0 |
| Return backfacing model used for the view. More...
|
|
virtual void | SetBackfacingModel (const Graphic3d_TypeOfBackfacingModel theModel)=0 |
| Sets backfacing model for the view. More...
|
|
virtual const Handle< Graphic3d_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...
|
|
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...
|
|
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...
|
|
|
Standard_Integer | myId |
| camera projection parameters to restore after closing XR session (FOV, aspect and similar) More...
|
|
Graphic3d_RenderingParams | myRenderParams |
| camera projection parameters to restore after closing XR session (FOV, aspect and similar) More...
|
|
Quantity_ColorRGBA | myBgColor |
| camera projection parameters to restore after closing XR session (FOV, aspect and similar) More...
|
|
Handle< Graphic3d_StructureManager > | myStructureManager |
| camera projection parameters to restore after closing XR session (FOV, aspect and similar) More...
|
|
Handle< Graphic3d_Camera > | myCamera |
| camera projection parameters to restore after closing XR session (FOV, aspect and similar) More...
|
|
Graphic3d_SequenceOfStructure | myStructsToCompute |
| camera projection parameters to restore after closing XR session (FOV, aspect and similar) More...
|
|
Graphic3d_SequenceOfStructure | myStructsComputed |
| camera projection parameters to restore after closing XR session (FOV, aspect and similar) More...
|
|
Graphic3d_MapOfStructure | myStructsDisplayed |
| camera projection parameters to restore after closing XR session (FOV, aspect and similar) More...
|
|
Handle< Graphic3d_NMapOfTransient > | myHiddenObjects |
| camera projection parameters to restore after closing XR session (FOV, aspect and similar) More...
|
|
Standard_Boolean | myIsInComputedMode |
| camera projection parameters to restore after closing XR session (FOV, aspect and similar) More...
|
|
Standard_Boolean | myIsActive |
| camera projection parameters to restore after closing XR session (FOV, aspect and similar) More...
|
|
Standard_Boolean | myIsRemoved |
| camera projection parameters to restore after closing XR session (FOV, aspect and similar) More...
|
|
Graphic3d_TypeOfShadingModel | myShadingModel |
| camera projection parameters to restore after closing XR session (FOV, aspect and similar) More...
|
|
Graphic3d_TypeOfVisualization | myVisualization |
| camera projection parameters to restore after closing XR session (FOV, aspect and similar) More...
|
|
Handle< Aspect_XRSession > | myXRSession |
| camera projection parameters to restore after closing XR session (FOV, aspect and similar) 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...
|
|
Graphic3d_GraduatedTrihedron | myGTrihedronData |
| camera projection parameters to restore after closing XR session (FOV, aspect and similar) More...
|
|
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...
|
|