|
Open CASCADE Technology
6.7.1
|
Constructs circle datums to be used in construction of
composite shapes.
More...
#include <AIS_Circle.hxx>

Public Member Functions | |
| AIS_Circle (const Handle< Geom_Circle > &aCircle) | |
Initializes this algorithm for constructing AIS circle <br> datums initializes the circle aCircle | |
| AIS_Circle (const Handle< Geom_Circle > &theCircle, const Standard_Real theUStart, const Standard_Real theUEnd, const Standard_Boolean theIsFilledCircleSens=Standard_False) | |
Initializes this algorithm for constructing AIS circle datums. <br> Initializes the circle theCircle, the arc | |
| virtual void | Compute (const Handle< Prs3d_Projector > &aProjector, const Handle< Geom_Transformation > &aTrsf, const Handle< Prs3d_Presentation > &aPresentation) |
| computes the presentation according to a point of view given by <aProjector>. To be Used when the associated degenerated Presentations have been transformed by <aTrsf> which is not a Pure Translation. The HLR Prs can't be deducted automatically WARNING :<aTrsf> must be applied to the object to display before computation !!! More... | |
| virtual Standard_Integer | Signature () const |
| Returns index 6 by default. More... | |
| virtual AIS_KindOfInteractive | Type () const |
| Indicates that the type of Interactive Object is a datum. More... | |
| const Handle_Geom_Circle & | Circle () const |
| Returns the circle component defined in SetCircle. More... | |
| void | Parameters (Standard_Real &u1, Standard_Real &u2) const |
| Constructs instances of the starting point and the end point parameters, u1 and u2. More... | |
| void | SetCircle (const Handle< Geom_Circle > &aCircle) |
| Allows you to provide settings for the circle datum aCircle. More... | |
| void | SetFirstParam (const Standard_Real u) |
| Allows you to set the parameter u for the starting point of an arc. More... | |
| void | SetLastParam (const Standard_Real u) |
| Allows you to provide the parameter u for the end point of an arc. More... | |
| void | SetColor (const Quantity_NameOfColor aColor) |
| Assigns the color aColor to the solid line boundary of the circle datum. More... | |
| void | SetColor (const Quantity_Color &aColor) |
| void | SetWidth (const Standard_Real aValue) |
| Assigns the width aValue to the solid line boundary of the circle datum. More... | |
| void | UnsetColor () |
| Removes color from the solid line boundary of the circle datum. More... | |
| void | UnsetWidth () |
| Removes width settings from the solid line boundary of the circle datum. More... | |
| Standard_Boolean | IsFilledCircleSens () const |
| Returns the type of sensitivity for the circle; More... | |
| void | SetFilledCircleSens (const Standard_Boolean theIsFilledCircleSens) |
Sets the type of sensitivity for the circle. If theIsFilledCircleSens set to Standard_True <br> then the whole circle will be detectable, otherwise only the boundary of the circle. | |
Public Member Functions inherited from AIS_InteractiveObject | |
| virtual Standard_Boolean | AcceptShapeDecomposition () const |
Informs the graphic context that the interactive Object <br> may be decomposed into sub-shapes for dynamic selection. | |
| void | SetCurrentFacingModel (const Aspect_TypeOfFacingModel aModel=Aspect_TOFM_BOTH_SIDE) |
change the current facing model apply on polygons for <br> SetColor(), SetTransparency(), SetMaterial() methods | |
| Aspect_TypeOfFacingModel | CurrentFacingModel () const |
| Returns the current facing model which is in effect. More... | |
| virtual Standard_Boolean | AcceptDisplayMode (const Standard_Integer aMode) const |
Returns true if the class of objects accepts the display mode aMode. <br> The interactive context can have a default mode of | |
| virtual Standard_Integer | DefaultDisplayMode () const |
Returns the default display mode. This method is to <br> be implemented when the main mode is not mode 0. | |
| void | Redisplay (const Standard_Boolean AllModes=Standard_False) |
| Updates the active presentation; if <AllModes> = Standard_True all the presentations inside are recomputed. More... | |
| void | SetInfiniteState (const Standard_Boolean aFlag=Standard_True) |
Sets the infinite state flag aFlage. <br> if <aFlag> = True , the interactiveObject is | |
| Standard_Boolean | IsInfinite () const |
| Returns true if the interactive object is infinite. In this case, its graphic presentations are not taken into account in the fit-all view. More... | |
| Standard_Boolean | HasInteractiveContext () const |
Indicates whether the Interactive Object has a pointer <br> to an interactive context. | |
| Handle_AIS_InteractiveContext | GetContext () 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 <br> to the default drawing tool or "Drawer" if there is none. | |
| Standard_Boolean | HasOwner () const |
Returns true if the object has an owner attributed to it. <br> The owner can be a shape for a set of sub-shapes or | |
| const Handle_Standard_Transient & | GetOwner () const |
Returns the owner of the Interactive Object. <br> The owner can be a shape for a set of sub-shapes or | |
| void | SetOwner (const Handle< Standard_Transient > &ApplicativeEntity) |
Allows you to attribute the owner ApplicativeEntity to <br> an Interactive Object. This can be a shape for a set of | |
| void | ClearOwner () |
Each Interactive Object has methods which allow us <br> to attribute an Owner to it in the form of a Transient. | |
| Standard_Boolean | HasUsers () const |
| const TColStd_ListOfTransient & | Users () const |
| void | AddUser (const Handle< Standard_Transient > &aUser) |
| void | ClearUsers () |
| Standard_Boolean | HasDisplayMode () const |
| Returns true if the Interactive Object has a display mode setting. Otherwise, it is displayed in Neutral Point. More... | |
| void | SetDisplayMode (const Standard_Integer aMode) |
Sets the display mode aMode for the interactive object. <br> An object can have its own temporary display mode, | |
| void | UnsetDisplayMode () |
| Removes display mode settings from the interactive object. More... | |
| Standard_Integer | DisplayMode () const |
Returns the display mode setting of the Interactive Object. <br> The range of possibilities is the following: | |
| Standard_Boolean | HasSelectionMode () const |
Allows you to change the selection mode of an <br> Interactive Object. | |
| Standard_Integer | SelectionMode () const |
| Returns the selection mode of the interactive object. More... | |
| void | SetSelectionMode (const Standard_Integer aMode) |
You can change the default selection mode index <br> aMode of an Interactive Object. | |
| void | UnsetSelectionMode () |
You can change the default selection mode index of <br> an Interactive Object. | |
| Standard_Integer | SelectionPriority () const |
Returns the selection priority setting. -1 indicates that there is none. <br> You can modify the selection priority of an owner to | |
| void | SetSelectionPriority (const Standard_Integer aPriority) |
Allows you to provide a setting aPriority for selection priority. <br> You can modify selection priority of an owner to make | |
| void | UnsetSelectionPriority () |
| Removes the setting for selection priority. SelectionPriority then returns -1. More... | |
| Standard_Boolean | HasSelectionPriority () const |
Returns true if there is a setting for selection priority. <br> You can modify selection priority of an owner to make | |
| Standard_Boolean | HasHilightMode () const |
| Returns true if the Interactive Object is in highlight mode. More... | |
| Standard_Integer | HilightMode () const |
Returns the setting for highlight mode. <br> At dynamic detection, the presentation echoed by the | |
| void | SetHilightMode (const Standard_Integer anIndex) |
Sets the highlight mode anIndex for the interactive object. <br> If, for example, you want to systematically highlight | |
| void | UnsetHilightMode () |
| Allows the user to take a given Prs for hilight ex : for a shape which would be displayed in shading mode the hilight Prs is the wireframe mode. if No specific hilight mode is defined, the displayed Prs will be the hilighted one. More... | |
| Standard_Boolean | HasColor () const |
| Returns true if the Interactive Object has color. More... | |
| virtual Quantity_NameOfColor | Color () const |
| Returns the color setting of the Interactive Object. More... | |
| virtual void | Color (Quantity_Color &aColor) const |
| 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. <br> This will be on of the following materials: | |
| virtual void | SetMaterial (const Graphic3d_NameOfMaterial aName) |
Sets the name aName for material defining this <br> display attribute for the interactive object. | |
| virtual void | SetMaterial (const Graphic3d_MaterialAspect &aName) |
Sets the material aMat defining this display attribute <br> for the interactive object. | |
| virtual void | UnsetMaterial () |
| Removes the setting for material. More... | |
| virtual void | SetTransparency (const Standard_Real aValue=0.6) |
Attributes a setting aValue for transparency. <br> The transparency value should be between 0.0 and 1.0. | |
| Standard_Boolean | IsTransparent () const |
| Returns true if there is a transparency setting. More... | |
| virtual Standard_Real | Transparency () const |
Returns the transparency setting. <br> This will be between 0.0 and 1.0. | |
| virtual void | UnsetTransparency () |
| Removes the transparency setting. The object is opaque by default. More... | |
| virtual void | SetAttributes (const Handle< AIS_Drawer > &aDrawer) |
| Initializes the drawing tool aDrawer. More... | |
| const Handle_AIS_Drawer & | Attributes () const |
| Returns the attributes settings. More... | |
| virtual void | UnsetAttributes () |
| Clears settings provided by the drawing tool aDrawer. More... | |
| void | State (const Standard_Integer theState) |
| Standard_Integer | State () const |
| void | SetTransformation (const Handle< Geom_Transformation > &aTranformation, const Standard_Boolean postConcatenate=Standard_False, const Standard_Boolean updateSelection=Standard_True) |
Transforms all presentations of the object <br> and replace the actual transformation matrix if <postConcatenate> is FALSE. | |
| void | UnsetTransformation () |
| Deactivate the current transformation More... | |
| Handle_Geom_Transformation | Transformation () |
Returns the current transformation associated <br> to the first available presentation of this object. | |
| Standard_Boolean | HasTransformation () const |
| Returns TRUE when this object is transformed 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, const Standard_Boolean globalChange=Standard_True) |
| Sets the graphic basic aspect to the current presentation. When <globalChange> is TRUE , the full object presentation is changed. When <globalChange> is FALSE , only the current group of the object presentation is changed. 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. <br>
It modifies all existing presentations of <anObj> (if any), <br>
so it is reasonable to call this method after <anObj> has been displayed. <br>
Otherwise, Compute() method should pass Graphic3d_AspectFillArea3d <br>
aspect from <myDrawer> to Graphic3d_Group to make polygon offsets work. <br>
| |
| 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... | |
Public Member Functions inherited from SelectMgr_SelectableObject | |
| virtual Standard_Integer | NbPossibleSelection () const |
| defines the number of different modes of selection (or decomposition) for an Object. More... | |
| void | UpdateSelection () |
| re-computes the sensitive primitives for all modes More... | |
| void | UpdateSelection (const Standard_Integer aMode) |
| re-computes the sensitive primitives which correspond to the <amode>th selection mode. More... | |
| void | AddSelection (const Handle< SelectMgr_Selection > &aSelection, const Standard_Integer aMode) |
Adds the selection aSelection with the selection mode <br> index aMode to this framework. | |
| void | ClearSelections (const Standard_Boolean update=Standard_False) |
Empties all the selections in the SelectableObject <br>
<update> parameter defines whether all object's <br>
selections should be flagged for further update or not. | |
| const Handle_SelectMgr_Selection & | Selection (const Standard_Integer aMode) const |
| Returns the selection Selection having the selection mode aMode. More... | |
| Standard_Boolean | HasSelection (const Standard_Integer aMode) const |
Returns true if a selection corresponding to the <br> selection mode aMode is present in this framework. | |
| void | Init () |
| Begins the iteration scanning for sensitive primitives. More... | |
| Standard_Boolean | More () const |
| Continues the iteration scanning for sensitive primitives. More... | |
| void | Next () |
| Continues the iteration scanning for sensitive primitives. More... | |
| const Handle_SelectMgr_Selection & | CurrentSelection () const |
| Returns the current selection in this framework. More... | |
| void | ResetLocation () |
| virtual void | UpdateLocation () |
| Recomputes the location of the selection aSelection. More... | |
| virtual void | HilightSelected (const Handle< PrsMgr_PresentationManager3d > &PM, const SelectMgr_SequenceOfOwner &Seq) |
| Method which draws selected owners ( for fast presentation draw ) More... | |
| virtual void | ClearSelected () |
Method which clear all selected owners belonging <br> to this selectable object ( for fast presentation draw ) | |
| virtual void | HilightOwnerWithColor (const Handle< PrsMgr_PresentationManager3d > &thePM, const Quantity_NameOfColor theColor, const Handle< SelectMgr_EntityOwner > &theOwner) |
Method which hilight an owner belonging to <br> this selectable object ( for fast presentation draw ) | |
| virtual Standard_Boolean | IsAutoHilight () const |
If returns True, the old mechanism for highlighting <br> selected objects is used (HilightSelected Method may be empty). | |
| virtual void | SetAutoHilight (const Standard_Boolean newAutoHilight) |
| Set AutoHilight property to true or false //! Sets up Transform Persistence Mode for this object More... | |
| Handle_Prs3d_Presentation | GetHilightPresentation (const Handle< PrsMgr_PresentationManager3d > &TheMgr) |
| Handle_Prs3d_Presentation | GetSelectPresentation (const Handle< PrsMgr_PresentationManager3d > &TheMgr) |
| virtual void | SetZLayer (const Handle< PrsMgr_PresentationManager > &thePrsMgr, const Standard_Integer theLayerId) |
Set Z layer ID and update all presentations of <br> the selectable object. The layer can be set only for displayed object. | |
Public Member Functions inherited from PrsMgr_PresentableObject | |
| PrsMgr_TypeOfPresentation3d | TypeOfPresentation3d () const |
| Returns information on whether the object accepts display in HLR mode or not. More... | |
| virtual void | SetTransformPersistence (const Graphic3d_TransModeFlags &aFlag, const gp_Pnt &APoint) |
Sets up Transform Persistence Mode for this object. <br> This function used to lock in object position, rotation and / or zooming relative to camera position. | |
| void | SetTransformPersistence (const Graphic3d_TransModeFlags &aFlag) |
| Calls previous method with point (0,0,0) More... | |
| Graphic3d_TransModeFlags | GetTransformPersistenceMode () const |
| Gets Transform Persistence Mode for this object More... | |
| gp_Pnt | GetTransformPersistencePoint () const |
| Gets point of transform persistence for this object More... | |
| void | SetTypeOfPresentation (const PrsMgr_TypeOfPresentation3d aType) |
| void | SetToUpdate (const Standard_Integer aMode) |
| flags the Prs of mode <AMode> to be Updated. the Update will be done when needed. More... | |
| void | SetToUpdate () |
| flags all the Presentations to be Updated. More... | |
| void | ToBeUpdated (TColStd_ListOfInteger &ListOfMode) const |
| gives the list of modes which are flagged "to be updated". More... | |
| virtual void | SetLocation (const TopLoc_Location &aLoc) |
| Standard_Boolean | HasLocation () const |
| const TopLoc_Location & | Location () const |
| virtual void | UpdateLocation (const Handle< Prs3d_Presentation > &P) |
| Standard_Integer | GetZLayer (const Handle< PrsMgr_PresentationManager > &thePrsMgr) const |
Get ID of Z layer. If no presentations of object is displayed, <br> and layer ID is unavailable, the -1 value is returned. | |
| virtual void | AddClipPlane (const Graphic3d_ClipPlane_Handle &thePlane) |
Adds clip plane for graphical clipping for all display mode <br> presentations. The composition of clip planes truncates the rendering | |
| virtual void | RemoveClipPlane (const Graphic3d_ClipPlane_Handle &thePlane) |
| Removes previously added clip plane. More... | |
| virtual void | SetClipPlanes (const Graphic3d_SequenceOfHClipPlane &thePlanes) |
Set clip planes for graphical clipping for all display mode presentations. <br> The composition of clip planes truncates the rendering space to convex | |
| const Graphic3d_SequenceOfHClipPlane & | GetClipPlanes () const |
| Get clip planes. More... | |
Public Member Functions inherited from MMgt_TShared | |
| virtual void | Delete () const |
| Memory deallocator for transient classes. 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 | ShallowDump (Standard_OStream &) const |
| virtual const Handle_Standard_Type & | DynamicType () const |
| Returns a type information object about this object. More... | |
| Standard_Boolean | IsInstance (const 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 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... | |
| virtual Handle_Standard_Transient | This () const |
| Returns a Handle which references this object. Must never be called to objects created in stack. More... | |
| Standard_Integer | GetRefCount () const |
| Get the reference counter of this object. More... | |
Additional Inherited Members | |
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 dependant of the view of Display More... | |
Protected Member Functions inherited from SelectMgr_SelectableObject | |
| SelectMgr_SelectableObject (const PrsMgr_TypeOfPresentation3d aTypeOfPresentation3d=PrsMgr_TOP_AllView) | |
| virtual void | UpdateLocation (const Handle< SelectMgr_Selection > &aSelection) |
| Updates locations in all sensitive entities from <aSelection> and in corresponding entity owners. More... | |
Protected Member Functions inherited from PrsMgr_PresentableObject | |
| PrsMgr_PresentableObject (const PrsMgr_TypeOfPresentation3d aTypeOfPresentation3d=PrsMgr_TOP_AllView) | |
| void | Update (const Standard_Boolean AllModes=Standard_False) |
| recomputes all presentations of the object. More... | |
| void | Update (const Standard_Integer aMode, const Standard_Boolean ClearOther) |
| Recomputes the presentation in the given mode. If ClearOther is true, other presentation will be cleared. More... | |
| virtual void | Fill (const Handle< PrsMgr_PresentationManager > &aPresentationManager, const Handle< PrsMgr_Presentation > &aPresentation, const Standard_Integer aMode=0) |
| High-level interface for controlling polygon offsets More... | |
| PrsMgr_Presentations & | Presentations () |
| virtual void | UpdateClipping () |
General virtual method for internal update of presentation state <br> when some modifications on list of clip planes occurs. Base | |
Protected Attributes inherited from AIS_InteractiveObject | |
| Handle_AIS_Drawer | myDrawer |
| Standard_Real | myTransparency |
| Quantity_Color | myOwnColor |
| Graphic3d_NameOfMaterial | myOwnMaterial |
| Standard_Integer | myHilightMode |
| Standard_Real | myOwnWidth |
| Standard_Boolean | myInfiniteState |
| Standard_Boolean | hasOwnColor |
| Standard_Boolean | hasOwnMaterial |
| Aspect_TypeOfFacingModel | myCurrentFacingModel |
| Standard_Boolean | myRecomputeEveryPrs |
| TColStd_ListOfInteger | myToRecomputeModes |
Protected Attributes inherited from SelectMgr_SelectableObject | |
| SelectMgr_SequenceOfSelection | myselections |
Protected Attributes inherited from PrsMgr_PresentableObject | |
| PrsMgr_Presentations | myPresentations |
| PrsMgr_TypeOfPresentation3d | myTypeOfPresentation3d |
| TopLoc_Location | myLocation |
| Graphic3d_SequenceOfHClipPlane | myClipPlanes |
Constructs circle datums to be used in construction of
composite shapes.
| AIS_Circle::AIS_Circle | ( | const Handle< Geom_Circle > & | aCircle | ) |
Initializes this algorithm for constructing AIS circle <br>
datums initializes the circle aCircle
| AIS_Circle::AIS_Circle | ( | const Handle< Geom_Circle > & | theCircle, |
| const Standard_Real | theUStart, | ||
| const Standard_Real | theUEnd, | ||
| const Standard_Boolean | theIsFilledCircleSens = Standard_False |
||
| ) |
Initializes this algorithm for constructing AIS circle datums. <br>
Initializes the circle theCircle, the arc
starting point theUStart, the arc ending point theUEnd,
and the type of sensitivity theIsFilledCircleSens.
| const Handle_Geom_Circle& AIS_Circle::Circle | ( | ) | const |
Returns the circle component defined in SetCircle.
|
virtual |
computes the presentation according to a point of view
given by <aProjector>.
To be Used when the associated degenerated Presentations
have been transformed by <aTrsf> which is not a Pure
Translation. The HLR Prs can't be deducted automatically
WARNING :<aTrsf> must be applied
to the object to display before computation !!!
Reimplemented from PrsMgr_PresentableObject.
| Standard_Boolean AIS_Circle::IsFilledCircleSens | ( | ) | const |
Returns the type of sensitivity for the circle;
| void AIS_Circle::Parameters | ( | Standard_Real & | u1, |
| Standard_Real & | u2 | ||
| ) | const |
Constructs instances of the starting point and the end
point parameters, u1 and u2.
| void AIS_Circle::SetCircle | ( | const Handle< Geom_Circle > & | aCircle | ) |
Allows you to provide settings for the circle datum aCircle.
|
virtual |
Assigns the color aColor to the solid line boundary of the circle datum.
Reimplemented from AIS_InteractiveObject.
|
virtual |
Reimplemented from AIS_InteractiveObject.
| void AIS_Circle::SetFilledCircleSens | ( | const Standard_Boolean | theIsFilledCircleSens | ) |
Sets the type of sensitivity for the circle. If theIsFilledCircleSens set to Standard_True <br>
then the whole circle will be detectable, otherwise only the boundary of the circle.
| void AIS_Circle::SetFirstParam | ( | const Standard_Real | u | ) |
Allows you to set the parameter u for the starting point of an arc.
| void AIS_Circle::SetLastParam | ( | const Standard_Real | u | ) |
Allows you to provide the parameter u for the end point of an arc.
|
virtual |
Assigns the width aValue to the solid line boundary of the circle datum.
Reimplemented from AIS_InteractiveObject.
|
virtual |
Returns index 6 by default.
Reimplemented from AIS_InteractiveObject.
|
virtual |
Indicates that the type of Interactive Object is a datum.
Reimplemented from AIS_InteractiveObject.
|
virtual |
Removes color from the solid line boundary of the circle datum.
Reimplemented from AIS_InteractiveObject.
|
virtual |
Removes width settings from the solid line boundary of the circle datum.
Reimplemented from AIS_InteractiveObject.
1.8.5