Locates the x, y and z axes in an Interactive Object. These are used to orient it correctly in presentations from different viewpoints, or to construct a revolved shape, for example, from one of the axes. Conversely, an axis can be created to build a revolved shape and then situated relative to one of the axes of the view. More...
#include <AIS_Axis.hxx>
Inheritance diagram for AIS_Axis:
Public Member Functions | |
| AIS_Axis (const Handle< Geom_Line > &aComponent) | |
| Initializes the line aComponent. More... | |
| AIS_Axis (const Handle< Geom_Axis2Placement > &aComponent, const AIS_TypeOfAxis anAxisType) | |
| initializes the axis2 position aComponent. The coordinate system used is right-handed. More... | |
| AIS_Axis (const Handle< Geom_Axis1Placement > &anAxis) | |
| Initializes the axis1 position anAxis. More... | |
| AIS_Axis (const gp_Ax1 &theAxis, const Standard_Real theLength=-1) | |
| Initializes the ray as axis with start point and direction. More... | |
| const Handle< Geom_Line > & | Component () const |
| Returns the axis entity aComponent and identifies it as a component of a shape. More... | |
| void | SetComponent (const Handle< Geom_Line > &aComponent) |
| Sets the coordinates of the lin aComponent. More... | |
| const Handle< Geom_Axis2Placement > & | Axis2Placement () const |
| Returns the position of axis2 and positions it by identifying it as the x, y, or z axis and giving its direction in 3D space. The coordinate system used is right-handed. More... | |
| void | SetAxis2Placement (const Handle< Geom_Axis2Placement > &aComponent, const AIS_TypeOfAxis anAxisType) |
| Allows you to provide settings for aComponent:the position and direction of an axis in 3D space. The coordinate system used is right-handed. More... | |
| void | SetAxis1Placement (const Handle< Geom_Axis1Placement > &anAxis) |
| Constructs a new line to serve as the axis anAxis in 3D space. More... | |
| AIS_TypeOfAxis | TypeOfAxis () const |
| Returns the type of axis. More... | |
| void | SetTypeOfAxis (const AIS_TypeOfAxis theTypeAxis) |
| Constructs the entity theTypeAxis to stock information concerning type of axis. More... | |
| Standard_Boolean | IsXYZAxis () const |
| Returns a signature of 2 for axis datums. When you activate mode 2 by a signature, you pick AIS objects of type AIS_Axis. More... | |
| Standard_Boolean | AcceptDisplayMode (const Standard_Integer aMode) const override |
| Returns true if the interactive object accepts the display mode aMode. More... | |
| virtual Standard_Integer | Signature () const override |
| Specifies additional characteristics of Interactive Object of Type(); -1 by default. Among the datums, this signature is attributed to the shape. The remaining datums have the following default signatures: More... | |
| virtual AIS_KindOfInteractive | Type () const override |
| Returns the kind of Interactive Object; AIS_KindOfInteractive_None by default. More... | |
| void | SetColor (const Quantity_Color &aColor) override |
| 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()) More... | |
| void | SetWidth (const Standard_Real aValue) override |
| Allows you to provide the setting aValue for width. Only the Interactive Object knows which Drawer attribute is affected by the width setting. More... | |
| void | SetDisplayAspect (const Handle< Prs3d_LineAspect > &theNewDatumAspect) |
| Set required visualization parameters. More... | |
| void | UnsetColor () override |
| 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. More... | |
| void | UnsetWidth () override |
| Reset width to default value. More... | |
 Public Member Functions inherited from AIS_InteractiveObject | |
| void | Redisplay (const Standard_Boolean AllModes=Standard_False) |
| Updates the active presentation; if <AllModes> = Standard_True all the presentations inside are recomputed. IMPORTANT: It is preferable to call Redisplay method of corresponding AIS_InteractiveContext instance for cases when it is accessible. This method just redirects call to myCTXPtr, so this class field must be up to date for proper result. More... | |
| Standard_Boolean | HasInteractiveContext () const |
| Indicates whether the Interactive Object has a pointer to an interactive context. More... | |
| AIS_InteractiveContext * | InteractiveContext () const |
| Returns the context pointer to the interactive context. More... | |
| virtual void | SetContext (const Handle< AIS_InteractiveContext > &aCtx) |
| Sets the interactive context aCtx and provides a link to the default drawing tool or "Drawer" if there is none. More... | |
| Standard_Boolean | HasOwner () const |
| Returns true if the object has an owner attributed to it. The owner can be a shape for a set of sub-shapes or a sub-shape for sub-shapes which it is composed of, and takes the form of a transient. More... | |
| const Handle< Standard_Transient > & | GetOwner () const |
| Returns the owner of the Interactive Object. The owner can be a shape for a set of sub-shapes or a sub-shape for sub-shapes which it is composed of, and takes the form of a transient. There are two types of owners: More... | |
| void | SetOwner (const Handle< Standard_Transient > &theApplicativeEntity) |
| Allows you to attribute the owner theApplicativeEntity to an Interactive Object. This can be a shape for a set of sub-shapes or a sub-shape for sub-shapes which it is composed of. The owner takes the form of a transient. More... | |
| void | ClearOwner () |
| Each Interactive Object has methods which allow us to attribute an Owner to it in the form of a Transient. This method removes the owner from the graphic entity. More... | |
| virtual Standard_Boolean | ProcessDragging (const Handle< AIS_InteractiveContext > &theCtx, const Handle< V3d_View > &theView, const Handle< SelectMgr_EntityOwner > &theOwner, const Graphic3d_Vec2i &theDragFrom, const Graphic3d_Vec2i &theDragTo, const AIS_DragAction theAction) |
| Drag object in the viewer. More... | |
| Handle< AIS_InteractiveContext > | GetContext () const |
| Returns the context pointer to the interactive context. More... | |
| Standard_Boolean | HasPresentation () const |
| Returns TRUE when this object has a presentation in the current DisplayMode() More... | |
| Handle< Prs3d_Presentation > | Presentation () const |
| Returns the current presentation of this object according to the current DisplayMode() More... | |
| void | SetAspect (const Handle< Prs3d_BasicAspect > &anAspect) |
| Sets the graphic basic aspect to the current presentation. 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 SelectMgr_SelectableObject | |
| virtual | ~SelectMgr_SelectableObject () |
| Clears all selections of the object. More... | |
| virtual Standard_Boolean | AcceptShapeDecomposition () const |
| Informs the graphic context that the interactive Object may be decomposed into sub-shapes for dynamic selection. The most used Interactive Object is AIS_Shape. More... | |
| void | RecomputePrimitives () |
| Re-computes the sensitive primitives for all modes. IMPORTANT: Do not use this method to update selection primitives except implementing custom selection manager! This method does not take into account necessary BVH updates, but may invalidate the pointers it refers to. TO UPDATE SELECTION properly from outside classes, use method UpdateSelection. More... | |
| void | RecomputePrimitives (const Standard_Integer theMode) |
| Re-computes the sensitive primitives which correspond to the <theMode>th selection mode. IMPORTANT: Do not use this method to update selection primitives except implementing custom selection manager! selection manager! This method does not take into account necessary BVH updates, but may invalidate the pointers it refers to. TO UPDATE SELECTION properly from outside classes, use method UpdateSelection. More... | |
| void | AddSelection (const Handle< SelectMgr_Selection > &aSelection, const Standard_Integer aMode) |
| Adds the selection aSelection with the selection mode index aMode to this framework. More... | |
| void | ClearSelections (const Standard_Boolean update=Standard_False) |
| Empties all the selections in the SelectableObject <update> parameter defines whether all object's selections should be flagged for further update or not. This improved method can be used to recompute an object's selection (without redisplaying the object completely) when some selection mode is activated not for the first time. More... | |
| const Handle< SelectMgr_Selection > & | Selection (const Standard_Integer theMode) const |
| Returns the selection having specified selection mode or NULL. More... | |
| Standard_Boolean | HasSelection (const Standard_Integer theMode) const |
| Returns true if a selection corresponding to the selection mode theMode was computed for this object. More... | |
| const SelectMgr_SequenceOfSelection & | Selections () const |
| Return the sequence of selections. More... | |
| void | ResetTransformation () override |
| resets local transformation to identity. More... | |
| virtual void | UpdateTransformation () override |
| Recomputes the location of the selection aSelection. More... | |
| virtual void | UpdateTransformations (const Handle< SelectMgr_Selection > &aSelection) |
| Updates locations in all sensitive entities from <aSelection> and in corresponding entity owners. More... | |
| virtual void | HilightSelected (const Handle< PrsMgr_PresentationManager > &thePrsMgr, const SelectMgr_SequenceOfOwner &theSeq) |
| Method which draws selected owners ( for fast presentation draw ) More... | |
| virtual void | ClearSelected () |
| Method which clear all selected owners belonging to this selectable object ( for fast presentation draw ) More... | |
| virtual void | ClearDynamicHighlight (const Handle< PrsMgr_PresentationManager > &theMgr) |
| Method that needs to be implemented when the object manages selection and dynamic highlighting on its own. Clears or invalidates dynamic highlight presentation. By default it clears immediate draw of given presentation manager. More... | |
| virtual void | HilightOwnerWithColor (const Handle< PrsMgr_PresentationManager > &thePM, const Handle< Prs3d_Drawer > &theStyle, const Handle< SelectMgr_EntityOwner > &theOwner) |
| Method which hilight an owner belonging to this selectable object ( for fast presentation draw ) More... | |
| virtual Standard_Boolean | IsAutoHilight () const |
| If returns True, the old mechanism for highlighting selected objects is used (HilightSelected Method may be empty). If returns False, the HilightSelected method will be fully responsible for highlighting selected entity owners belonging to this selectable object. More... | |
| virtual void | SetAutoHilight (const Standard_Boolean theAutoHilight) |
| Set AutoHilight property to true or false. More... | |
| Handle< Prs3d_Presentation > | GetHilightPresentation (const Handle< PrsMgr_PresentationManager > &thePrsMgr) |
| Creates or returns existing presentation for highlighting detected object. More... | |
| Handle< Prs3d_Presentation > | GetSelectPresentation (const Handle< PrsMgr_PresentationManager > &thePrsMgr) |
| Creates or returns existing presentation for highlighting selected object. More... | |
| virtual void | ErasePresentations (Standard_Boolean theToRemove) |
| Removes presentations returned by GetHilightPresentation() and GetSelectPresentation(). More... | |
| virtual void | SetZLayer (const Graphic3d_ZLayerId theLayerId) override |
| Set Z layer ID and update all presentations of the selectable object. The layers mechanism allows drawing objects in higher layers in overlay of objects in lower layers. More... | |
| void | UpdateSelection (const Standard_Integer theMode=-1) |
| Sets update status FULL to selections of the object. Must be used as the only method of UpdateSelection from outer classes to prevent BVH structures from being outdated. More... | |
| void | SetAssemblyOwner (const Handle< SelectMgr_EntityOwner > &theOwner, const Standard_Integer theMode=-1) |
| Sets common entity owner for assembly sensitive object entities. More... | |
| Bnd_Box | BndBoxOfSelected (const Handle< SelectMgr_IndexedMapOfOwner > &theOwners) |
| Returns a bounding box of sensitive entities with the owners given if they are a part of activated selection. More... | |
| Standard_Integer | GlobalSelectionMode () const |
| Returns the mode for selection of object as a whole; 0 by default. More... | |
| virtual Handle< SelectMgr_EntityOwner > | GlobalSelOwner () const |
| Returns the owner of mode for selection of object as a whole. More... | |
| virtual const Handle< SelectMgr_EntityOwner > & | GetAssemblyOwner () const |
| Returns common entity owner if the object is an assembly. More... | |
| Public Member Functions inherited from PrsMgr_PresentableObject | |
| PrsMgr_Presentations & | Presentations () |
| Return presentations. More... | |
| Graphic3d_ZLayerId | ZLayer () const |
| Get ID of Z layer for main presentation. More... | |
| 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). More... | |
| 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. More... | |
| const Handle< Graphic3d_ViewAffinity > & | ViewAffinity () const |
| Return view affinity mask. More... | |
| Standard_Boolean | HasDisplayMode () const |
| Returns true if the Interactive Object has display mode setting overriding global setting (within Interactive Context). More... | |
| 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(). More... | |
| 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. More... | |
| void | UnsetDisplayMode () |
| Removes display mode settings from the interactive object. More... | |
| Standard_Boolean | HasHilightMode () const |
| Returns true if the Interactive Object is in highlight mode. More... | |
| Standard_Integer | HilightMode () const |
| Returns highlight display mode. This is obsolete method for backward compatibility - use ::HilightAttributes() and ::DynamicHilightAttributes() instead. More... | |
| void | SetHilightMode (const Standard_Integer theMode) |
| Sets highlight display mode. This is obsolete method for backward compatibility - use ::HilightAttributes() and ::DynamicHilightAttributes() instead. More... | |
| void | UnsetHilightMode () |
| Unsets highlight display mode. More... | |
| virtual Standard_Integer | DefaultDisplayMode () const |
| Returns the default display mode. More... | |
| Standard_Boolean | ToBeUpdated (Standard_Boolean theToIncludeHidden=Standard_False) const |
| Returns TRUE if any active presentation has invalidation flag. More... | |
| void | SetToUpdate (Standard_Integer theMode) |
| Flags presentation to be updated; UpdatePresentations() will recompute these presentations. More... | |
| void | SetToUpdate () |
| flags all the Presentations to be Updated. More... | |
| 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. More... | |
| void | SetInfiniteState (const Standard_Boolean theFlag=Standard_True) |
| Sets if object should be considered as infinite. More... | |
| PrsMgr_TypeOfPresentation3d | TypeOfPresentation3d () const |
| Returns information on whether the object accepts display in HLR mode or not. More... | |
| void | SetTypeOfPresentation (const PrsMgr_TypeOfPresentation3d theType) |
| Set type of presentation. More... | |
| PrsMgr_DisplayStatus | DisplayStatus () const |
| Return presentation display status; PrsMgr_DisplayStatus_None by default. More... | |
| const Handle< Prs3d_Drawer > & | Attributes () const |
| Returns the attributes settings. More... | |
| virtual void | SetAttributes (const Handle< Prs3d_Drawer > &theDrawer) |
| Initializes the drawing tool theDrawer. More... | |
| 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(). More... | |
| virtual void | SetHilightAttributes (const Handle< Prs3d_Drawer > &theDrawer) |
| Initializes the hilight drawing tool theDrawer. More... | |
| 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(). More... | |
| virtual void | SetDynamicHilightAttributes (const Handle< Prs3d_Drawer > &theDrawer) |
| Initializes the dynamic hilight drawing tool. More... | |
| virtual void | UnsetHilightAttributes () |
| Clears settings provided by the hilight drawing tool theDrawer. More... | |
| void | SynchronizeAspects () |
| Synchronize presentation aspects after their modification. More... | |
| 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. More... | |
| 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. More... | |
| 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. More... | |
| 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. More... | |
| 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. More... | |
| Standard_Boolean | HasTransformation () const |
| Returns true if object has a transformation that is different from the identity. More... | |
| 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. More... | |
| 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. More... | |
| 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. More... | |
| const gp_GTrsf & | InversedTransformation () const |
| Return inversed transformation. More... | |
| const Handle< TopLoc_Datum3D > & | CombinedParentTransformation () const |
| Return combined parent transformation. More... | |
| const Handle< Graphic3d_SequenceOfHClipPlane > & | ClipPlanes () const |
| Get clip planes. More... | |
| 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. More... | |
| 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. More... | |
| virtual void | RemoveClipPlane (const Handle< Graphic3d_ClipPlane > &thePlane) |
| Removes previously added clip plane. More... | |
| PrsMgr_PresentableObject * | Parent () const |
| Returns parent of current object in scene hierarchy. More... | |
| const PrsMgr_ListOfPresentableObjects & | Children () const |
| Returns children of the current object. More... | |
| virtual void | AddChild (const Handle< PrsMgr_PresentableObject > &theObject) |
| Makes theObject child of current object in scene hierarchy. More... | |
| 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. More... | |
| virtual void | RemoveChild (const Handle< PrsMgr_PresentableObject > &theObject) |
| Removes theObject from children of current object in scene hierarchy. More... | |
| 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. More... | |
| Standard_Boolean | HasOwnPresentations () const |
| Returns true if object should have own presentations. More... | |
| 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. More... | |
| void | SetIsoOnTriangulation (const Standard_Boolean theIsEnabled) |
| Enables or disables on-triangulation build of isolines according to the flag given. More... | |
| Aspect_TypeOfFacingModel | CurrentFacingModel () const |
| Returns the current facing model which is in effect. More... | |
| 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. More... | |
| Standard_Boolean | HasColor () const |
| Returns true if the Interactive Object has color. More... | |
| virtual void | Color (Quantity_Color &theColor) const |
| Returns the color setting of the Interactive Object. More... | |
| Standard_Boolean | HasWidth () const |
| Returns true if the Interactive Object has width. More... | |
| Standard_Real | Width () const |
| Returns the width setting of the Interactive Object. More... | |
| Standard_Boolean | HasMaterial () const |
| Returns true if the Interactive Object has a setting for material. More... | |
| virtual Graphic3d_NameOfMaterial | Material () const |
| Returns the current material setting as enumeration value. More... | |
| 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. More... | |
| virtual void | UnsetMaterial () |
| Removes the setting for material. More... | |
| Standard_Boolean | IsTransparent () const |
| Returns true if there is a transparency setting. More... | |
| 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. More... | |
| 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. More... | |
| virtual void | UnsetTransparency () |
| Removes the transparency setting. The object is opaque by default. More... | |
| virtual Standard_Boolean | HasPolygonOffsets () const |
| Returns Standard_True if <myDrawer> has non-null shading aspect. More... | |
| virtual void | PolygonOffsets (Standard_Integer &aMode, Standard_ShortReal &aFactor, Standard_ShortReal &aUnits) const |
| Retrieves current polygon offsets settings from <myDrawer>. More... | |
| 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. More... | |
| virtual void | UnsetAttributes () |
| Clears settings provided by the drawing tool aDrawer. More... | |
| void | ToBeUpdated (TColStd_ListOfInteger &ListOfMode) const |
| gives the list of modes which are flagged "to be updated". More... | |
| 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. More... | |
| void | SetPropagateVisualState (const Standard_Boolean theFlag) |
| Change the value of the flag "propagate visual state". 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... | |
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 AIS_InteractiveObject | |
| AIS_InteractiveObject (const PrsMgr_TypeOfPresentation3d aTypeOfPresentation3d=PrsMgr_TOP_AllView) | |
| The TypeOfPresention3d means that the interactive object may have a presentation dependent on the view of Display. More... | |
| void | SetDisplayStatus (PrsMgr_DisplayStatus theStatus) |
| Set presentation display status. More... | |
| Protected Member Functions inherited from SelectMgr_SelectableObject | |
| SelectMgr_SelectableObject (const PrsMgr_TypeOfPresentation3d aTypeOfPresentation3d=PrsMgr_TOP_AllView) | |
| Protected empty constructor. More... | |
| void | setGlobalSelMode (const Standard_Integer theMode) |
| Override global selection mode. More... | |
| virtual void | UpdateClipping () override |
| Update clipping planes state. More... | |
| virtual void | updateSelection (const Standard_Integer theMode) |
| Sets update status FULL to selections of the object. Must be used as the only method of UpdateSelection from outer classes to prevent BVH structures from being outdated. More... | |
| Protected Member Functions inherited from PrsMgr_PresentableObject | |
| void | Update (Standard_Boolean theToIncludeHidden=Standard_False) |
| Recomputes all presentations of the object. More... | |
| void | Update (Standard_Integer theMode, Standard_Boolean theToClearOther) |
| Recomputes the presentation in the given mode. More... | |
| PrsMgr_PresentableObject (const PrsMgr_TypeOfPresentation3d aTypeOfPresentation3d=PrsMgr_TOP_AllView) | |
| Protected empty constructor. More... | |
| virtual | ~PrsMgr_PresentableObject () |
| Destructor. More... | |
| 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). More... | |
| 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. More... | |
| Standard_Boolean | UpdatePresentations (Standard_Boolean theToIncludeHidden=Standard_False) |
| Recomputes invalidated presentations of the object. More... | |
| 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. More... | |
| virtual void | setLocalTransformation (const Handle< TopLoc_Datum3D > &theTransformation) |
| Sets local transformation to theTransformation. More... | |
| void | recomputeComputed () const |
| Recompute computed (HLR) presentations (when view is in computed mode). More... | |
| 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. More... | |
| Static Protected Member Functions inherited from PrsMgr_PresentableObject | |
| static const gp_Trsf & | getIdentityTrsf () |
| Return the identity transformation. More... | |
| Protected Attributes inherited from AIS_InteractiveObject | |
| AIS_InteractiveContext * | myCTXPtr |
| pointer to Interactive Context, where object is currently displayed; More... | |
| Handle< Standard_Transient > | myOwner |
| application-specific owner object More... | |
| Protected Attributes inherited from SelectMgr_SelectableObject | |
| SelectMgr_SequenceOfSelection | myselections |
| list of selections More... | |
| Handle< Prs3d_Presentation > | mySelectionPrs |
| optional presentation for highlighting selected object More... | |
| Handle< Prs3d_Presentation > | myHilightPrs |
| optional presentation for highlighting detected object More... | |
| Standard_Integer | myGlobalSelMode |
| global selection mode More... | |
| Standard_Boolean | myAutoHilight |
| auto-highlighting flag defining More... | |
| Protected Attributes inherited from PrsMgr_PresentableObject | |
| PrsMgr_PresentableObject * | myParent |
| pointer to the parent object More... | |
| PrsMgr_Presentations | myPresentations |
| list of presentations More... | |
| Handle< Graphic3d_ViewAffinity > | myViewAffinity |
| view affinity mask More... | |
| Handle< Graphic3d_SequenceOfHClipPlane > | myClipPlanes |
| sequence of object-specific clipping planes More... | |
| Handle< Prs3d_Drawer > | myDrawer |
| main presentation attributes More... | |
| Handle< Prs3d_Drawer > | myHilightDrawer |
| (optional) custom presentation attributes for highlighting selected object More... | |
| Handle< Prs3d_Drawer > | myDynHilightDrawer |
| (optional) custom presentation attributes for highlighting detected object More... | |
| Handle< Graphic3d_TransformPers > | myTransformPersistence |
| transformation persistence More... | |
| Handle< TopLoc_Datum3D > | myLocalTransformation |
| local transformation relative to parent object More... | |
| Handle< TopLoc_Datum3D > | myTransformation |
| absolute transformation of this object (combined parents + local transformations) More... | |
| Handle< TopLoc_Datum3D > | myCombinedParentTransform |
| transformation of parent object (combined for all parents) More... | |
| PrsMgr_ListOfPresentableObjects | myChildren |
| list of children More... | |
| gp_GTrsf | myInvTransformation |
| inversion of absolute transformation (combined parents + local transformations) More... | |
| PrsMgr_TypeOfPresentation3d | myTypeOfPresentation3d |
| presentation type More... | |
| PrsMgr_DisplayStatus | myDisplayStatus |
| presentation display status More... | |
| Aspect_TypeOfFacingModel | myCurrentFacingModel |
| current facing model More... | |
| Standard_ShortReal | myOwnWidth |
| custom width value More... | |
| Standard_Boolean | hasOwnColor |
| own color flag More... | |
| Standard_Boolean | hasOwnMaterial |
| own material flag More... | |
| Standard_Boolean | myInfiniteState |
| infinite flag More... | |
| Standard_Boolean | myIsMutable |
| mutable flag More... | |
| Standard_Boolean | myHasOwnPresentations |
| flag indicating if object should have own presentations More... | |
| Standard_Boolean | myToPropagateVisualState |
| flag indicating if visual state (display/erase/color) should be propagated to all children More... | |
Detailed Description
Locates the x, y and z axes in an Interactive Object. These are used to orient it correctly in presentations from different viewpoints, or to construct a revolved shape, for example, from one of the axes. Conversely, an axis can be created to build a revolved shape and then situated relative to one of the axes of the view.
Constructor & Destructor Documentation
◆ AIS_Axis() [1/4]
◆ AIS_Axis() [2/4]
| AIS_Axis::AIS_Axis | ( | const Handle< Geom_Axis2Placement > & | aComponent, |
| const AIS_TypeOfAxis | anAxisType | ||
| ) |
initializes the axis2 position aComponent. The coordinate system used is right-handed.
◆ AIS_Axis() [3/4]
| AIS_Axis::AIS_Axis | ( | const Handle< Geom_Axis1Placement > & | anAxis | ) |
Initializes the axis1 position anAxis.
◆ AIS_Axis() [4/4]
| AIS_Axis::AIS_Axis | ( | const gp_Ax1 & | theAxis, |
| const Standard_Real | theLength = -1 |
||
| ) |
Initializes the ray as axis with start point and direction.
- Parameters
-
[in] theAxis Start point and direction of the ray [in] theLength Optional length of the ray (ray is infinite by default).
Member Function Documentation
◆ AcceptDisplayMode()
|
overridevirtual |
Returns true if the interactive object accepts the display mode aMode.
Reimplemented from PrsMgr_PresentableObject.
◆ Axis2Placement()
|
inline |
Returns the position of axis2 and positions it by identifying it as the x, y, or z axis and giving its direction in 3D space. The coordinate system used is right-handed.
◆ Component()
Returns the axis entity aComponent and identifies it as a component of a shape.
◆ IsXYZAxis()
|
inline |
◆ SetAxis1Placement()
| void AIS_Axis::SetAxis1Placement | ( | const Handle< Geom_Axis1Placement > & | anAxis | ) |
Constructs a new line to serve as the axis anAxis in 3D space.
◆ SetAxis2Placement()
| void AIS_Axis::SetAxis2Placement | ( | const Handle< Geom_Axis2Placement > & | aComponent, |
| const AIS_TypeOfAxis | anAxisType | ||
| ) |
Allows you to provide settings for aComponent:the position and direction of an axis in 3D space. The coordinate system used is right-handed.
◆ SetColor()
|
overridevirtual |
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())
Reimplemented from PrsMgr_PresentableObject.
◆ SetComponent()
Sets the coordinates of the lin aComponent.
◆ SetDisplayAspect()
| void AIS_Axis::SetDisplayAspect | ( | const Handle< Prs3d_LineAspect > & | theNewDatumAspect | ) |
Set required visualization parameters.
◆ SetTypeOfAxis()
|
inline |
Constructs the entity theTypeAxis to stock information concerning type of axis.
◆ SetWidth()
|
overridevirtual |
Allows you to provide the setting aValue for width. Only the Interactive Object knows which Drawer attribute is affected by the width setting.
Reimplemented from PrsMgr_PresentableObject.
◆ Signature()
|
inlineoverridevirtual |
Specifies additional characteristics of Interactive Object of Type(); -1 by default. Among the datums, this signature is attributed to the shape. The remaining datums have the following default signatures:
- Point signature 1
- Axis signature 2
- Trihedron signature 3
- PlaneTrihedron signature 4
- Line signature 5
- Circle signature 6
- Plane signature 7.
Reimplemented from AIS_InteractiveObject.
◆ Type()
|
inlineoverridevirtual |
Returns the kind of Interactive Object; AIS_KindOfInteractive_None by default.
Reimplemented from AIS_InteractiveObject.
◆ TypeOfAxis()
|
inline |
Returns the type of axis.
◆ UnsetColor()
|
overridevirtual |
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.
Reimplemented from PrsMgr_PresentableObject.
◆ UnsetWidth()
|
overridevirtual |
Reset width to default value.
Reimplemented from PrsMgr_PresentableObject.
The documentation for this class was generated from the following file:
