|
| | StdSelect_Shape (const TopoDS_Shape &theShape, const Handle< Prs3d_Drawer > &theDrawer=Handle< Prs3d_Drawer >()) |
| |
| virtual void | Compute (const Handle< PrsMgr_PresentationManager > &thePrsMgr, const Handle< Prs3d_Presentation > &thePrs, const Standard_Integer theMode) override |
| | Calculates the 3D view presentation for specified display mode. This is a key interface for implementing Presentable Object interface.
|
| |
| const TopoDS_Shape & | Shape () const |
| |
| void | Shape (const TopoDS_Shape &theShape) |
| |
| virtual void | DumpJson (Standard_OStream &theOStream, Standard_Integer theDepth=-1) const override |
| | Dumps the content of me into the stream.
|
| |
| PrsMgr_Presentations & | Presentations () |
| | Return presentations.
|
| |
| Graphic3d_ZLayerId | ZLayer () const |
| | Get ID of Z layer for main presentation.
|
| |
| virtual void | SetZLayer (const Graphic3d_ZLayerId theLayerId) |
| | Set Z layer ID and update all presentations of the presentable object. The layers mechanism allows drawing objects in higher layers in overlay of objects in lower layers.
|
| |
| Standard_Boolean | IsMutable () const |
| | Returns true if object has mutable nature (content or location are be changed regularly). Mutable object will be managed in different way than static onces (another optimizations).
|
| |
| virtual void | SetMutable (const Standard_Boolean theIsMutable) |
| | Sets if the object has mutable nature (content or location will be changed regularly). This method should be called before object displaying to take effect.
|
| |
| const Handle< Graphic3d_ViewAffinity > & | ViewAffinity () const |
| | Return view affinity mask.
|
| |
| Standard_Boolean | HasDisplayMode () const |
| | Returns true if the Interactive Object has display mode setting overriding global setting (within Interactive Context).
|
| |
| Standard_Integer | DisplayMode () const |
| | Returns the display mode setting of the Interactive Object. The range of supported display mode indexes should be specified within object definition and filtered by AccepDisplayMode().
|
| |
| void | SetDisplayMode (const Standard_Integer theMode) |
| | Sets the display mode for the interactive object. An object can have its own temporary display mode, which is different from that proposed by the interactive context.
|
| |
| void | UnsetDisplayMode () |
| | Removes display mode settings from the interactive object.
|
| |
| Standard_Boolean | HasHilightMode () const |
| | Returns true if the Interactive Object is in highlight mode.
|
| |
| Standard_Integer | HilightMode () const |
| | Returns highlight display mode. This is obsolete method for backward compatibility - use HilightAttributes() and DynamicHilightAttributes() instead.
|
| |
| void | SetHilightMode (const Standard_Integer theMode) |
| | Sets highlight display mode. This is obsolete method for backward compatibility - use HilightAttributes() and DynamicHilightAttributes() instead.
|
| |
| void | UnsetHilightMode () |
| | Unsets highlight display mode.
|
| |
| virtual Standard_Boolean | AcceptDisplayMode (const Standard_Integer theMode) const |
| | Returns true if the class of objects accepts specified display mode index. The interactive context can have a default mode of representation for the set of Interactive Objects. This mode may not be accepted by a given class of objects. Consequently, this virtual method allowing us to get information about the class in question must be implemented. At least one display mode index should be accepted by this method. Although subclass can leave default implementation, it is highly desired defining exact list of supported modes instead, which is usually an enumeration for one object or objects class sharing similar list of display modes.
|
| |
| virtual Standard_Integer | DefaultDisplayMode () const |
| | Returns the default display mode.
|
| |
| Standard_Boolean | ToBeUpdated (Standard_Boolean theToIncludeHidden=Standard_False) const |
| | Returns TRUE if any active presentation has invalidation flag.
|
| |
| void | SetToUpdate (Standard_Integer theMode) |
| | Flags presentation to be updated; UpdatePresentations() will recompute these presentations.
|
| |
| void | SetToUpdate () |
| | flags all the Presentations to be Updated.
|
| |
| Standard_Boolean | IsInfinite () const |
| | Returns true if the interactive object is infinite; FALSE by default. This flag affects various operations operating on bounding box of graphic presentations of this object. For instance, infinite objects are not taken in account for View FitAll. This does not necessarily means that object is actually infinite, auxiliary objects might be also marked with this flag to achieve desired behavior.
|
| |
| void | SetInfiniteState (const Standard_Boolean theFlag=Standard_True) |
| | Sets if object should be considered as infinite.
|
| |
| PrsMgr_TypeOfPresentation3d | TypeOfPresentation3d () const |
| | Returns information on whether the object accepts display in HLR mode or not.
|
| |
| void | SetTypeOfPresentation (const PrsMgr_TypeOfPresentation3d theType) |
| | Set type of presentation.
|
| |
| PrsMgr_DisplayStatus | DisplayStatus () const |
| | Return presentation display status; PrsMgr_DisplayStatus_None by default.
|
| |
| const Handle< Prs3d_Drawer > & | Attributes () const |
| | Returns the attributes settings.
|
| |
| virtual void | SetAttributes (const Handle< Prs3d_Drawer > &theDrawer) |
| | Initializes the drawing tool theDrawer.
|
| |
| const Handle< Prs3d_Drawer > & | HilightAttributes () const |
| | Returns the hilight attributes settings. When not NULL, overrides both Prs3d_TypeOfHighlight_LocalSelected and Prs3d_TypeOfHighlight_Selected defined within AIS_InteractiveContext::HighlightStyle().
|
| |
| virtual void | SetHilightAttributes (const Handle< Prs3d_Drawer > &theDrawer) |
| | Initializes the hilight drawing tool theDrawer.
|
| |
| const Handle< Prs3d_Drawer > & | DynamicHilightAttributes () const |
| | Returns the hilight attributes settings. When not NULL, overrides both Prs3d_TypeOfHighlight_LocalDynamic and Prs3d_TypeOfHighlight_Dynamic defined within AIS_InteractiveContext::HighlightStyle().
|
| |
| virtual void | SetDynamicHilightAttributes (const Handle< Prs3d_Drawer > &theDrawer) |
| | Initializes the dynamic hilight drawing tool.
|
| |
| virtual void | UnsetHilightAttributes () |
| | Clears settings provided by the hilight drawing tool theDrawer.
|
| |
| void | SynchronizeAspects () |
| | Synchronize presentation aspects after their modification.
|
| |
| const Handle< Graphic3d_TransformPers > & | TransformPersistence () const |
| | Returns Transformation Persistence defining a special Local Coordinate system where this presentable object is located or NULL handle if not defined. Position of the object having Transformation Persistence is mutable and depends on camera position. The same applies to a bounding box of the object.
|
| |
| virtual void | SetTransformPersistence (const Handle< Graphic3d_TransformPers > &theTrsfPers) |
| | Sets up Transform Persistence defining a special Local Coordinate system where this object should be located. Note that management of Transform Persistence object is more expensive than of the normal one, because it requires its position being recomputed basing on camera position within each draw call / traverse.
|
| |
| const Handle< TopLoc_Datum3D > & | LocalTransformationGeom () const |
| | Return the local transformation. Note that the local transformation of the object having Transformation Persistence is applied within Local Coordinate system defined by this Persistence.
|
| |
| void | SetLocalTransformation (const gp_Trsf &theTrsf) |
| | Sets local transformation to theTransformation. Note that the local transformation of the object having Transformation Persistence is applied within Local Coordinate system defined by this Persistence.
|
| |
| void | SetLocalTransformation (const Handle< TopLoc_Datum3D > &theTrsf) |
| | Sets local transformation to theTransformation. Note that the local transformation of the object having Transformation Persistence is applied within Local Coordinate system defined by this Persistence.
|
| |
| Standard_Boolean | HasTransformation () const |
| | Returns true if object has a transformation that is different from the identity.
|
| |
| const Handle< TopLoc_Datum3D > & | TransformationGeom () const |
| | Return the transformation taking into account transformation of parent object(s). Note that the local transformation of the object having Transformation Persistence is applied within Local Coordinate system defined by this Persistence.
|
| |
| const gp_Trsf & | LocalTransformation () const |
| | Return the local transformation. Note that the local transformation of the object having Transformation Persistence is applied within Local Coordinate system defined by this Persistence.
|
| |
| const gp_Trsf & | Transformation () const |
| | Return the transformation taking into account transformation of parent object(s). Note that the local transformation of the object having Transformation Persistence is applied within Local Coordinate system defined by this Persistence.
|
| |
| const gp_GTrsf & | InversedTransformation () const |
| | Return inversed transformation.
|
| |
| const Handle< TopLoc_Datum3D > & | CombinedParentTransformation () const |
| | Return combined parent transformation.
|
| |
| virtual void | ResetTransformation () |
| | resets local transformation to identity.
|
| |
| virtual void | UpdateTransformation () |
| | Updates final transformation (parent + local) of presentable object and its presentations.
|
| |
| const Handle< Graphic3d_SequenceOfHClipPlane > & | ClipPlanes () const |
| | Get clip planes.
|
| |
| virtual void | SetClipPlanes (const Handle< Graphic3d_SequenceOfHClipPlane > &thePlanes) |
| | Set clip planes for graphical clipping for all display mode presentations. The composition of clip planes truncates the rendering space to convex volume. Please be aware that number of supported clip plane is limited. The planes which exceed the limit are ignored. Besides of this, some planes can be already set in view where the object is shown: the number of these planes should be subtracted from limit to predict the maximum possible number of object clipping planes.
|
| |
| virtual void | AddClipPlane (const Handle< Graphic3d_ClipPlane > &thePlane) |
| | Adds clip plane for graphical clipping for all display mode presentations. The composition of clip planes truncates the rendering space to convex volume. Please be aware that number of supported clip plane is limited. The planes which exceed the limit are ignored. Besides of this, some planes can be already set in view where the object is shown: the number of these planes should be subtracted from limit to predict the maximum possible number of object clipping planes.
|
| |
| virtual void | RemoveClipPlane (const Handle< Graphic3d_ClipPlane > &thePlane) |
| | Removes previously added clip plane.
|
| |
| PrsMgr_PresentableObject * | Parent () const |
| | Returns parent of current object in scene hierarchy.
|
| |
| const PrsMgr_ListOfPresentableObjects & | Children () const |
| | Returns children of the current object.
|
| |
| virtual void | AddChild (const Handle< PrsMgr_PresentableObject > &theObject) |
| | Makes theObject child of current object in scene hierarchy.
|
| |
| void | AddChildWithCurrentTransformation (const Handle< PrsMgr_PresentableObject > &theObject) |
| | Makes theObject child of current object in scene hierarchy with keeping the current global transformation So the object keeps the same position/orientation in the global CS.
|
| |
| virtual void | RemoveChild (const Handle< PrsMgr_PresentableObject > &theObject) |
| | Removes theObject from children of current object in scene hierarchy.
|
| |
| void | RemoveChildWithRestoreTransformation (const Handle< PrsMgr_PresentableObject > &theObject) |
| | Removes theObject from children of current object in scene hierarchy with keeping the current global transformation. So the object keeps the same position/orientation in the global CS.
|
| |
| Standard_Boolean | HasOwnPresentations () const |
| | Returns true if object should have own presentations.
|
| |
| virtual void | BoundingBox (Bnd_Box &theBndBox) |
| | Returns bounding box of object correspondingly to its current display mode. This method requires presentation to be already computed, since it relies on bounding box of presentation structures, which are supposed to be same/close amongst different display modes of this object.
|
| |
| void | SetIsoOnTriangulation (const Standard_Boolean theIsEnabled) |
| | Enables or disables on-triangulation build of isolines according to the flag given.
|
| |
| Aspect_TypeOfFacingModel | CurrentFacingModel () const |
| | Returns the current facing model which is in effect.
|
| |
| void | SetCurrentFacingModel (const Aspect_TypeOfFacingModel theModel=Aspect_TOFM_BOTH_SIDE) |
| | change the current facing model apply on polygons for SetColor(), SetTransparency(), SetMaterial() methods default facing model is Aspect_TOFM_TWO_SIDE. This mean that attributes is applying both on the front and back face.
|
| |
| Standard_Boolean | HasColor () const |
| | Returns true if the Interactive Object has color.
|
| |
| virtual void | Color (Quantity_Color &theColor) const |
| | Returns the color setting of the Interactive Object.
|
| |
| virtual void | SetColor (const Quantity_Color &theColor) |
| | Only the interactive object knowns which Drawer attribute is affected by the color, if any (ex: for a wire,it's the wireaspect field of the drawer, but for a vertex, only the point aspect field is affected by the color). WARNING : Do not forget to set the corresponding fields here (hasOwnColor and myDrawer->SetColor())
|
| |
| virtual void | UnsetColor () |
| | Removes color settings. Only the Interactive Object knows which Drawer attribute is affected by the color setting. For a wire, for example, wire aspect is the attribute affected. For a vertex, however, only point aspect is affected by the color setting.
|
| |
| Standard_Boolean | HasWidth () const |
| | Returns true if the Interactive Object has width.
|
| |
| Standard_Real | Width () const |
| | Returns the width setting of the Interactive Object.
|
| |
| virtual void | SetWidth (const Standard_Real theWidth) |
| | Allows you to provide the setting aValue for width. Only the Interactive Object knows which Drawer attribute is affected by the width setting.
|
| |
| virtual void | UnsetWidth () |
| | Reset width to default value.
|
| |
| Standard_Boolean | HasMaterial () const |
| | Returns true if the Interactive Object has a setting for material.
|
| |
| virtual Graphic3d_NameOfMaterial | Material () const |
| | Returns the current material setting as enumeration value.
|
| |
| virtual void | SetMaterial (const Graphic3d_MaterialAspect &aName) |
| | Sets the material aMat defining this display attribute for the interactive object. Material aspect determines shading aspect, color and transparency of visible entities.
|
| |
| virtual void | UnsetMaterial () |
| | Removes the setting for material.
|
| |
| Standard_Boolean | IsTransparent () const |
| | Returns true if there is a transparency setting.
|
| |
| virtual Standard_Real | Transparency () const |
| | Returns the transparency setting. This will be between 0.0 and 1.0. At 0.0 an object will be totally opaque, and at 1.0, fully transparent.
|
| |
| virtual void | SetTransparency (const Standard_Real aValue=0.6) |
| | Attributes a setting aValue for transparency. The transparency value should be between 0.0 and 1.0. At 0.0 an object will be totally opaque, and at 1.0, fully transparent. Warning At a value of 1.0, there may be nothing visible.
|
| |
| virtual void | UnsetTransparency () |
| | Removes the transparency setting. The object is opaque by default.
|
| |
| virtual Standard_Boolean | HasPolygonOffsets () const |
| | Returns Standard_True if <myDrawer> has non-null shading aspect.
|
| |
| virtual void | PolygonOffsets (Standard_Integer &aMode, Standard_ShortReal &aFactor, Standard_ShortReal &aUnits) const |
| | Retrieves current polygon offsets settings from <myDrawer>.
|
| |
| virtual void | SetPolygonOffsets (const Standard_Integer aMode, const Standard_ShortReal aFactor=1.0, const Standard_ShortReal aUnits=0.0) |
| | Sets up polygon offsets for this object.
|
| |
| virtual void | UnsetAttributes () |
| | Clears settings provided by the drawing tool aDrawer.
|
| |
| void | ToBeUpdated (TColStd_ListOfInteger &ListOfMode) const |
| | gives the list of modes which are flagged "to be updated".
|
| |
| Standard_Boolean | ToPropagateVisualState () const |
| | Get value of the flag "propagate visual state" It means that the display/erase/color visual state is propagated automatically to all children; by default, the flag is true.
|
| |
| void | SetPropagateVisualState (const Standard_Boolean theFlag) |
| | Change the value of the flag "propagate visual state".
|
| |
 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 () |
| | Destructor must be virtual.
|
| |
| virtual const opencascade::handle< Standard_Type > & | DynamicType () const |
| | Returns a type descriptor about this object.
|
| |
| Standard_Boolean | IsInstance (const opencascade::handle< Standard_Type > &theType) const |
| | Returns a true value if this is an instance of Type.
|
| |
| Standard_Boolean | IsInstance (const Standard_CString theTypeName) const |
| | Returns a true value if this is an instance of TypeName.
|
| |
| 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.
|
| |
| 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.
|
| |
| 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.
|
| |
| Standard_Integer | GetRefCount () const noexcept |
| | Get the reference counter of this object.
|
| |
| void | IncrementRefCounter () noexcept |
| | Increments the reference counter of this object.
|
| |
| Standard_Integer | DecrementRefCounter () noexcept |
| | Decrements the reference counter of this object; returns the decremented value.
|
| |
| virtual void | Delete () const |
| | Memory deallocator for transient classes.
|
| |
|
| 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.
|
| |
| void | Update (Standard_Boolean theToIncludeHidden=Standard_False) |
| | Recomputes all presentations of the object.
|
| |
| void | Update (Standard_Integer theMode, Standard_Boolean theToClearOther) |
| | Recomputes the presentation in the given mode.
|
| |
| | PrsMgr_PresentableObject (const PrsMgr_TypeOfPresentation3d aTypeOfPresentation3d=PrsMgr_TOP_AllView) |
| | Protected empty constructor.
|
| |
| virtual | ~PrsMgr_PresentableObject () |
| | Destructor.
|
| |
| virtual void | Fill (const Handle< PrsMgr_PresentationManager > &thePrsMgr, const Handle< PrsMgr_Presentation > &thePrs, const Standard_Integer theMode) |
| | Fills the given 3D view presentation for specified display mode using Compute() method. In addition, configures other properties of presentation (transformation, clipping planes).
|
| |
| virtual void | computeHLR (const Handle< Graphic3d_Camera > &theProjector, const Handle< TopLoc_Datum3D > &theTrsf, const Handle< Prs3d_Presentation > &thePrs) |
| | Calculates hidden line removal presentation for specific camera position. Each of the views in the viewer and every modification such as rotation, for example, entails recalculation. Default implementation throws Standard_NotImplemented exception Warning! The transformation must be applied to the object before computation.
|
| |
| Standard_Boolean | UpdatePresentations (Standard_Boolean theToIncludeHidden=Standard_False) |
| | Recomputes invalidated presentations of the object.
|
| |
| virtual void | UpdateClipping () |
| | General virtual method for internal update of presentation state when some modifications on list of clip planes occurs. Base implementation propagate clip planes to every presentation.
|
| |
| virtual void | SetCombinedParentTransform (const Handle< TopLoc_Datum3D > &theTrsf) |
| | Sets myCombinedParentTransform to theTransformation. Thus object receives transformation from parent node and able to derive its own.
|
| |
| virtual void | setLocalTransformation (const Handle< TopLoc_Datum3D > &theTransformation) |
| | Sets local transformation to theTransformation.
|
| |
| void | recomputeComputed () const |
| | Recompute computed (HLR) presentations (when view is in computed mode).
|
| |
| void | replaceAspects (const Graphic3d_MapOfAspectsToAspects &theMap) |
| | Replace aspects of existing (computed) presentation groups, so that the new aspects can be applied without recomputing presentation. It is NOT recommended approach, because user has to fill such map and then search for each occurrence in computed groups. The recommended approach is computing presentation with necessary customized aspects, and then modify them directly followed by SynchronizeAspects() call.
|
| |
| static const gp_Trsf & | getIdentityTrsf () |
| | Return the identity transformation.
|
| |
| PrsMgr_PresentableObject * | myParent |
| | pointer to the parent object
|
| |
| PrsMgr_Presentations | myPresentations |
| | list of presentations
|
| |
| Handle< Graphic3d_ViewAffinity > | myViewAffinity |
| | view affinity mask
|
| |
| Handle< Graphic3d_SequenceOfHClipPlane > | myClipPlanes |
| | sequence of object-specific clipping planes
|
| |
| Handle< Prs3d_Drawer > | myDrawer |
| | main presentation attributes
|
| |
| Handle< Prs3d_Drawer > | myHilightDrawer |
| | (optional) custom presentation attributes for highlighting selected object
|
| |
| Handle< Prs3d_Drawer > | myDynHilightDrawer |
| | (optional) custom presentation attributes for highlighting detected object
|
| |
| Handle< Graphic3d_TransformPers > | myTransformPersistence |
| | transformation persistence
|
| |
| Handle< TopLoc_Datum3D > | myLocalTransformation |
| | local transformation relative to parent object
|
| |
| Handle< TopLoc_Datum3D > | myTransformation |
| | absolute transformation of this object (combined parents + local transformations)
|
| |
| Handle< TopLoc_Datum3D > | myCombinedParentTransform |
| | transformation of parent object (combined for all parents)
|
| |
| PrsMgr_ListOfPresentableObjects | myChildren |
| | list of children
|
| |
| gp_GTrsf | myInvTransformation |
| | inversion of absolute transformation (combined parents + local transformations)
|
| |
| PrsMgr_TypeOfPresentation3d | myTypeOfPresentation3d |
| | presentation type
|
| |
| PrsMgr_DisplayStatus | myDisplayStatus |
| | presentation display status
|
| |
| Aspect_TypeOfFacingModel | myCurrentFacingModel |
| | current facing model
|
| |
| Standard_ShortReal | myOwnWidth |
| | custom width value
|
| |
| Standard_Boolean | hasOwnColor |
| | own color flag
|
| |
| Standard_Boolean | hasOwnMaterial |
| | own material flag
|
| |
| Standard_Boolean | myInfiniteState |
| | infinite flag
|
| |
| Standard_Boolean | myIsMutable |
| | mutable flag
|
| |
| Standard_Boolean | myHasOwnPresentations |
| | flag indicating if object should have own presentations
|
| |
| Standard_Boolean | myToPropagateVisualState |
| | flag indicating if visual state (display/erase/color) should be propagated to all children
|
| |
