Open CASCADE Technology  7.2.0
Public Member Functions | Protected Member Functions | Protected Attributes

AIS_Relation Class Reference

One of the four types of interactive object in AIS,comprising dimensions and constraints. Serves as the abstract class for the seven relation classes as well as the seven dimension classes. The statuses available for relations between shapes are as follows: More...

#include <AIS_Relation.hxx>

Inheritance diagram for AIS_Relation:
Inheritance graph
[legend]

Public Member Functions

void SetColor (const Quantity_Color &theColor) override
 Allows you to provide settings for the color theColor of the lines representing the relation between the two shapes. More...
 
void UnsetColor () override
 Allows you to remove settings for the color of the lines representing the relation between the two shapes. More...
 
virtual AIS_KindOfInteractive Type () const override
 Returns the kind of Interactive Object: More...
 
virtual AIS_KindOfDimension KindOfDimension () const
 Indicates that the type of dimension is unknown. More...
 
virtual Standard_Boolean IsMovable () const
 Returns true if the interactive object is movable. More...
 
const TopoDS_ShapeFirstShape () const
 
virtual void SetFirstShape (const TopoDS_Shape &aFShape)
 
const TopoDS_ShapeSecondShape () const
 Returns the second shape. More...
 
virtual void SetSecondShape (const TopoDS_Shape &aSShape)
 Allows you to identify the second shape aSShape relative to the first. More...
 
void SetBndBox (const Standard_Real theXmin, const Standard_Real theYmin, const Standard_Real theZmin, const Standard_Real theXmax, const Standard_Real theYmax, const Standard_Real theZmax)
 
void UnsetBndBox ()
 
const Handle< Geom_Plane > & Plane () const
 Returns the plane. More...
 
void SetPlane (const Handle< Geom_Plane > &thePlane)
 Allows you to set the plane thePlane. This is used to define relations and dimensions in several daughter classes. More...
 
Standard_Real Value () const
 Returns the value of each object in the relation. More...
 
void SetValue (const Standard_Real theVal)
 Allows you to provide settings for the value theVal for each object in the relation. More...
 
const gp_PntPosition () const
 Returns the position set using SetPosition. More...
 
void SetPosition (const gp_Pnt &thePosition)
 Allows you to provide the objects in the relation with settings for a non-default position. More...
 
const TCollection_ExtendedStringText () const
 Returns settings for text aspect. More...
 
void SetText (const TCollection_ExtendedString &theText)
 Allows you to provide the settings theText for text aspect. More...
 
Standard_Real ArrowSize () const
 Returns the value for the size of the arrow identifying the relation between the two shapes. More...
 
void SetArrowSize (const Standard_Real theArrowSize)
 Allows you to provide settings for the size of the arrow theArrowSize identifying the relation between the two shapes. More...
 
DsgPrs_ArrowSide SymbolPrs () const
 Returns the value of the symbol presentation. This will be one of: More...
 
void SetSymbolPrs (const DsgPrs_ArrowSide theSymbolPrs)
 Allows you to provide settings for the symbol presentation. More...
 
void SetExtShape (const Standard_Integer theIndex)
 Allows you to set the status of the extension shape by the index aIndex. The status will be one of the following: More...
 
Standard_Integer ExtShape () const
 Returns the status index of the extension shape. More...
 
virtual Standard_Boolean AcceptDisplayMode (const Standard_Integer aMode) const override
 Returns true if the display mode aMode is accepted for the Interactive Objects in the relation. ComputeProjPresentation(me; aPres : Presentation from Prs3d; Curve1 : Curve from Geom; Curve2 : Curve from Geom; FirstP1 : Pnt from gp; LastP1 : Pnt from gp; FirstP2 : Pnt from gp; LastP2 : Pnt from gp; aColor : NameOfColor from Quantity = Quantity_NOC_PURPLE; aWidth : Real from Standard = 2; aProjTOL : TypeOfLine from Aspect = Aspect_TOL_DASH; aCallTOL : TypeOfLine from Aspect = Aspect_TOL_DOT) More...
 
void SetAutomaticPosition (const Standard_Boolean theStatus)
 
Standard_Boolean AutomaticPosition () const
 
- Public Member Functions inherited from AIS_InteractiveObject
virtual Standard_Integer Signature () const
 Specifies additional characteristics of Interactive Objects. A signature is, in fact, an index with integer values assigned different properties. This method is frequently used in conjuction with Type to give a particular type and signature to an Interactive Object. By default, the Interactive Object has a None type and a signature of 0. Among the datums, this signature is attributed to the shape The remaining datums have the following default signatures: 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. Activation methods for standard selection modes are proposed in the Interactive Context. These include selection by vertex or by edges. For datums with the same behavior as AIS_Shape, such as vetices and edges, we must redefine the virtual method so that AcceptShapeDecomposition returns false. Rule for selection : Mode 0 : Selection of the interactive Object itself Mode 1 : Selection of vertices Mode 2 : Selection Of Edges Mode 3 : Selection Of Wires Mode 4 : Selection Of Faces ... More...
 
void SetCurrentFacingModel (const Aspect_TypeOfFacingModel aModel=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...
 
Aspect_TypeOfFacingModel CurrentFacingModel () const
 Returns the current facing model which is in effect. More...
 
virtual void SetWidth (const Standard_Real aValue)
 Allows you to provide the setting aValue for width. Only the Interactive Object knows which Drawer attribute is affected by the width setting. More...
 
virtual void UnsetWidth ()
 
virtual Standard_Integer DefaultDisplayMode () const
 Returns the default display mode. This method is to be implemented when the main mode is not mode 0. More...
 
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...
 
void SetInfiniteState (const Standard_Boolean aFlag=Standard_True)
 Sets the infinite state flag aFlage. if <aFlag> = True , the interactiveObject is considered as infinite, i.e. its graphic presentations are not taken in account for View FitAll... More...
 
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 to an interactive context. More...
 
Handle< AIS_InteractiveContextGetContext () 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...
 
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. An object can have its own temporary display mode, which is different from that proposed by the interactive context. The range of possibilities currently proposed is the following: More...
 
void UnsetDisplayMode ()
 Removes display mode settings from the interactive object. More...
 
Standard_Integer DisplayMode () const
 Returns the display mode setting of the Interactive Object. The range of possibilities is the following: 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...
 
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. This will be on of the following materials: 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...
 
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...
 
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 UnsetTransparency ()
 Removes the transparency setting. The object is opaque by default. More...
 
virtual void UnsetAttributes () override
 Clears settings provided by the drawing tool aDrawer. More...
 
Standard_Boolean HasPresentation () const
 Returns TRUE when this object has a presentation in the current DisplayMode() More...
 
Handle< Prs3d_PresentationPresentation () 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 SetPolygonOffsets (const Standard_Integer aMode, const Standard_ShortReal aFactor=1.0, const Standard_ShortReal aUnits=0.0)
 Sets up polygon offsets for this object. It modifies all existing presentations of <anObj> (if any), so it is reasonable to call this method after <anObj> has been displayed. Otherwise, Compute() method should pass Graphic3d_AspectFillArea3d aspect from <myDrawer> to Graphic3d_Group to make polygon offsets work. 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 BoundingBox (Bnd_Box &theBndBox) override
 Returns bounding box of object correspondingly to its current display mode. More...
 
void SetIsoOnTriangulation (const Standard_Boolean theIsEnabled)
 Enables or disables on-triangulation build of isolines according to the flag given. More...
 
void SynchronizeAspects ()
 Synchronize presentation aspects after their modification. More...
 
- Public Member Functions inherited from SelectMgr_SelectableObject
virtual ~SelectMgr_SelectableObject ()
 Clears all selections of the object. More...
 
virtual void ComputeSelection (const Handle< SelectMgr_Selection > &aSelection, const Standard_Integer aMode)=0
 Recovers and calculates any sensitive primitive, aSelection, available in Shape mode, specified by aMode. As a rule, these are sensitive faces. This method is defined as virtual. This enables you to implement it in the creation of a new class of AIS Interactive Object. You need to do this and in so doing, redefine this method, if you create a class which enriches the list of signatures and types. 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 aMode) const
 Returns the selection Selection having the selection mode aMode. More...
 
virtual 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...
 
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 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_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 to this selectable object ( for fast presentation draw ) More...
 
virtual void ClearDynamicHighlight (const Handle< PrsMgr_PresentationManager3d > &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_PresentationManager3d > &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 newAutoHilight)
 Set AutoHilight property to true or false Sets up Transform Persistence Mode for this object. More...
 
Handle< Prs3d_PresentationGetHilightPresentation (const Handle< PrsMgr_PresentationManager3d > &TheMgr)
 
Handle< Prs3d_PresentationGetSelectPresentation (const Handle< PrsMgr_PresentationManager3d > &TheMgr)
 
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...
 
const Handle< SelectMgr_EntityOwner > & GetAssemblyOwner () const
 Returns common entity owner if the object is an assembly. 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. More...
 
virtual Handle< SelectMgr_EntityOwnerGlobalSelOwner () const
 Returns the owner of mode for selection of object as a whole. More...
 
- Public Member Functions inherited from PrsMgr_PresentableObject
PrsMgr_PresentationsPresentations ()
 
PrsMgr_TypeOfPresentation3d TypeOfPresentation3d () const
 Returns information on whether the object accepts display in HLR mode or not. More...
 
const Handle< Graphic3d_TransformPers > & TransformPersistence () const
 
virtual void SetTransformPersistence (const Handle< Graphic3d_TransformPers > &theTrsfPers)
 Sets up Transform Persistence for this object. More...
 
 Standard_DEPRECATED ("This method is deprecated - SetTransformPersistence() taking Graphic3d_TransformPers should be called instead") void SetTransformPersistence(const Graphic3d_TransModeFlags theMode
 Sets up Transform Persistence Mode for this object. This function used to lock in object position, rotation and / or zooming relative to camera position. Object will be drawn in the origin setted by thePoint parameter (except Graphic3d_TMF_TriedronPers flag. 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...
 
const Handle< Geom_Transformation > & LocalTransformationGeom () const
 Return the local transformation. More...
 
void SetLocalTransformation (const gp_Trsf &theTrsf)
 Sets local transformation to theTransformation. More...
 
void SetLocalTransformation (const Handle< Geom_Transformation > &theTrsf)
 Sets local transformation to theTransformation. More...
 
Standard_Boolean HasTransformation () const
 Returns true if object has a transformation that is different from the identity. More...
 
const Handle< Geom_Transformation > & TransformationGeom () const
 Return the transformation taking into account transformation of parent object(s). More...
 
const gp_TrsfLocalTransformation () const
 Return the local transformation. More...
 
const gp_TrsfTransformation () const
 Return the transformation taking into account transformation of parent object(s). More...
 
const gp_GTrsfInversedTransformation () const
 
virtual void UpdateTransformation (const Handle< Prs3d_Presentation > &P)
 
Graphic3d_ZLayerId ZLayer () const
 Get ID of Z layer. 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 substracted 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...
 
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...
 
 Standard_DEPRECATED ("This method is deprecated - overload taking Handle should be used instead") void SetClipPlanes(const Graphic3d_SequenceOfHClipPlane &thePlanes)
 
const Handle< Graphic3d_SequenceOfHClipPlane > & ClipPlanes () const
 Get clip planes. 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...
 
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 AddChild (const Handle< PrsMgr_PresentableObject > &theObject)
 Makes theObject child of current object in scene hierarchy. More...
 
virtual void RemoveChild (const Handle< PrsMgr_PresentableObject > &theObject)
 Removes theObject from children of current object in scene hierarchy. More...
 
const PrsMgr_ListOfPresentableObjectsChildren () const
 Returns children of the current object. More...
 
Standard_Boolean HasOwnPresentations () const
 Returns true if object should have own presentations. More...
 
PrsMgr_PresentableObjectPointer Parent () const
 Returns parent of current object in scene hierarchy. More...
 
virtual void SetAttributes (const Handle< Prs3d_Drawer > &theDrawer)
 Initializes the drawing tool theDrawer. More...
 
const Handle< Prs3d_Drawer > & Attributes () const
 Returns the attributes settings. 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. 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. 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...
 
- Public Member Functions inherited from Standard_Transient
 Standard_Transient ()
 Empty constructor. More...
 
 Standard_Transient (const Standard_Transient &)
 Copy constructor – does nothing. More...
 
Standard_Transientoperator= (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_TransientThis () 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...
 

Protected Member Functions

 AIS_Relation (const PrsMgr_TypeOfPresentation3d aTypeOfPresentation3d=PrsMgr_TOP_AllView)
 
void ComputeProjEdgePresentation (const Handle< Prs3d_Presentation > &aPres, const TopoDS_Edge &anEdge, const Handle< Geom_Curve > &ProjCurve, const gp_Pnt &FirstP, const gp_Pnt &LastP, const Quantity_NameOfColor aColor=Quantity_NOC_PURPLE, const Standard_Real aWidth=2, const Aspect_TypeOfLine aProjTOL=Aspect_TOL_DASH, const Aspect_TypeOfLine aCallTOL=Aspect_TOL_DOT) const
 Calculates the presentation aPres of the the edge anEdge and the curve it defines, ProjCurve. The later is also specified by the first point FirstP and the last point LastP. The presentation includes settings for color aColor, type - aProjTOL and aCallTOL - and width of line, aWidth. More...
 
void ComputeProjVertexPresentation (const Handle< Prs3d_Presentation > &aPres, const TopoDS_Vertex &aVertex, const gp_Pnt &ProjPoint, const Quantity_NameOfColor aColor=Quantity_NOC_PURPLE, const Standard_Real aWidth=2, const Aspect_TypeOfMarker aProjTOM=Aspect_TOM_PLUS, const Aspect_TypeOfLine aCallTOL=Aspect_TOL_DOT) const
 Calculates the presentation aPres of the the vertex aVertex and the point it defines, ProjPoint. The presentation includes settings for color aColor, type - aProjTOM and aCallTOL - and width of line, aWidth. 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 dependant of the view of Display. More...
 
- Protected Member Functions inherited from SelectMgr_SelectableObject
 SelectMgr_SelectableObject (const PrsMgr_TypeOfPresentation3d aTypeOfPresentation3d=PrsMgr_TOP_AllView)
 
void setGlobalSelMode (const Standard_Integer theMode)
 
virtual void updateSelection (const Standard_Integer theMode)
 
- Protected Member Functions inherited from PrsMgr_PresentableObject
 PrsMgr_PresentableObject (const PrsMgr_TypeOfPresentation3d aTypeOfPresentation3d=PrsMgr_TOP_AllView)
 
virtual ~PrsMgr_PresentableObject ()
 
virtual void Compute (const Handle< PrsMgr_PresentationManager3d > &aPresentationManager, const Handle< Prs3d_Presentation > &aPresentation, const Standard_Integer aMode)
 Calculates the 3D view aPresentation and its updates. The latter are managed by aPresentationManager. aPresentableObject has the display mode aMode; this has the default value of 0, that is, the wireframe display mode. More...
 
virtual void Compute (const Handle< Prs3d_Projector > &aProjector, const Handle< Prs3d_Presentation > &aPresentation)
 Calculates the 3D view aPresentation and its updates. The latter are managed by aPresentationManager. Each of the views in the viewer and every modification such as rotation, for example, entails recalculation. It must be redefined to implement hidden line removal for the object. The user never calls this method himself. This is done via the InteractiveContext object and is dependent on the point of view from which the object is displayed. More...
 
virtual void Compute (const Handle< Prs3d_Projector > &aProjector, const Handle< Geom_Transformation > &aTrsf, const Handle< Prs3d_Presentation > &aPresentation)
 Calculates the 3D view aPresentation and its updates. The latter are managed by aPresentationManager. A point of view is provided by the projector aProjector, and the geometric transformation which has transformed associated presentable objects is specified by aTrsf. This function is to be used in case where a hidden line removal display cannot be calculated automatically. This occurs when associated presentable objects have been transformed geometrically, but not translated. Warning The transformation aTrsf must be applied to the object before computation. More...
 
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)
 High-level interface for controlling polygon offsets. More...
 
virtual void SetCombinedParentTransform (const Handle< Geom_Transformation > &theTrsf)
 Sets myCombinedParentTransform to theTransformation. Thus object receives transformation from parent node and able to derive its own. More...
 
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. More...
 
virtual void setLocalTransformation (const Handle< Geom_Transformation > &theTransformation)
 Sets local transformation to theTransformation. More...
 

Protected Attributes

TopoDS_Shape myFShape
 
TopoDS_Shape mySShape
 
Handle< Geom_PlanemyPlane
 
Standard_Real myVal
 
gp_Pnt myPosition
 
TCollection_ExtendedString myText
 
Standard_Real myArrowSize
 
Standard_Boolean myAutomaticPosition
 
DsgPrs_ArrowSide mySymbolPrs
 
Standard_Integer myExtShape
 
gp_Pln myFirstPlane
 
gp_Pln mySecondPlane
 
Handle< Geom_SurfacemyFirstBasisSurf
 
Handle< Geom_SurfacemySecondBasisSurf
 
AIS_KindOfSurface myFirstSurfType
 
AIS_KindOfSurface mySecondSurfType
 
Standard_Real myFirstOffset
 
Standard_Real mySecondOffset
 
Bnd_Box myBndBox
 
Standard_Boolean myIsSetBndBox
 
Standard_Boolean myArrowSizeIsDefined
 
- Protected Attributes inherited from AIS_InteractiveObject
TColStd_ListOfInteger myToRecomputeModes
 
Standard_Real myOwnWidth
 
Aspect_TypeOfFacingModel myCurrentFacingModel
 
Standard_Boolean myInfiniteState
 
Standard_Boolean hasOwnColor
 
Standard_Boolean hasOwnMaterial
 
Standard_Boolean myRecomputeEveryPrs
 
- Protected Attributes inherited from SelectMgr_SelectableObject
SelectMgr_SequenceOfSelection myselections
 
Handle< SelectMgr_EntityOwnermyAssemblyOwner
 
Handle< Prs3d_PresentationmySelectionPrs
 
Handle< Prs3d_PresentationmyHilightPrs
 
Standard_Boolean myAutoHilight
 
- Protected Attributes inherited from PrsMgr_PresentableObject
PrsMgr_Presentations myPresentations
 
Handle< Graphic3d_SequenceOfHClipPlanemyClipPlanes
 
Handle< Prs3d_DrawermyDrawer
 
Handle< Prs3d_DrawermyHilightDrawer
 
Handle< Prs3d_DrawermyDynHilightDrawer
 
PrsMgr_TypeOfPresentation3d myTypeOfPresentation3d
 
Standard_Boolean myIsMutable
 
Standard_Boolean myHasOwnPresentations
 

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...
 
- Data Fields inherited from PrsMgr_PresentableObject
const gp_PntthePoint
 

Detailed Description

One of the four types of interactive object in AIS,comprising dimensions and constraints. Serves as the abstract class for the seven relation classes as well as the seven dimension classes. The statuses available for relations between shapes are as follows:

Constructor & Destructor Documentation

◆ AIS_Relation()

AIS_Relation::AIS_Relation ( const PrsMgr_TypeOfPresentation3d  aTypeOfPresentation3d = PrsMgr_TOP_AllView)
protected

Member Function Documentation

◆ AcceptDisplayMode()

virtual Standard_Boolean AIS_Relation::AcceptDisplayMode ( const Standard_Integer  aMode) const
overridevirtual

Returns true if the display mode aMode is accepted for the Interactive Objects in the relation. ComputeProjPresentation(me; aPres : Presentation from Prs3d; Curve1 : Curve from Geom; Curve2 : Curve from Geom; FirstP1 : Pnt from gp; LastP1 : Pnt from gp; FirstP2 : Pnt from gp; LastP2 : Pnt from gp; aColor : NameOfColor from Quantity = Quantity_NOC_PURPLE; aWidth : Real from Standard = 2; aProjTOL : TypeOfLine from Aspect = Aspect_TOL_DASH; aCallTOL : TypeOfLine from Aspect = Aspect_TOL_DOT)

Reimplemented from AIS_InteractiveObject.

◆ ArrowSize()

Standard_Real AIS_Relation::ArrowSize ( ) const
inline

Returns the value for the size of the arrow identifying the relation between the two shapes.

◆ AutomaticPosition()

Standard_Boolean AIS_Relation::AutomaticPosition ( ) const
inline

◆ ComputeProjEdgePresentation()

void AIS_Relation::ComputeProjEdgePresentation ( const Handle< Prs3d_Presentation > &  aPres,
const TopoDS_Edge anEdge,
const Handle< Geom_Curve > &  ProjCurve,
const gp_Pnt FirstP,
const gp_Pnt LastP,
const Quantity_NameOfColor  aColor = Quantity_NOC_PURPLE,
const Standard_Real  aWidth = 2,
const Aspect_TypeOfLine  aProjTOL = Aspect_TOL_DASH,
const Aspect_TypeOfLine  aCallTOL = Aspect_TOL_DOT 
) const
protected

Calculates the presentation aPres of the the edge anEdge and the curve it defines, ProjCurve. The later is also specified by the first point FirstP and the last point LastP. The presentation includes settings for color aColor, type - aProjTOL and aCallTOL - and width of line, aWidth.

◆ ComputeProjVertexPresentation()

void AIS_Relation::ComputeProjVertexPresentation ( const Handle< Prs3d_Presentation > &  aPres,
const TopoDS_Vertex aVertex,
const gp_Pnt ProjPoint,
const Quantity_NameOfColor  aColor = Quantity_NOC_PURPLE,
const Standard_Real  aWidth = 2,
const Aspect_TypeOfMarker  aProjTOM = Aspect_TOM_PLUS,
const Aspect_TypeOfLine  aCallTOL = Aspect_TOL_DOT 
) const
protected

Calculates the presentation aPres of the the vertex aVertex and the point it defines, ProjPoint. The presentation includes settings for color aColor, type - aProjTOM and aCallTOL - and width of line, aWidth.

◆ ExtShape()

Standard_Integer AIS_Relation::ExtShape ( ) const
inline

Returns the status index of the extension shape.

◆ FirstShape()

const TopoDS_Shape& AIS_Relation::FirstShape ( ) const
inline

◆ IsMovable()

virtual Standard_Boolean AIS_Relation::IsMovable ( ) const
virtual

◆ KindOfDimension()

virtual AIS_KindOfDimension AIS_Relation::KindOfDimension ( ) const
virtual

Indicates that the type of dimension is unknown.

Reimplemented in AIS_OffsetDimension, AIS_Chamf2dDimension, AIS_Chamf3dDimension, and AIS_EllipseRadiusDimension.

◆ Plane()

const Handle< Geom_Plane >& AIS_Relation::Plane ( ) const
inline

Returns the plane.

◆ Position()

const gp_Pnt& AIS_Relation::Position ( ) const
inline

Returns the position set using SetPosition.

◆ SecondShape()

const TopoDS_Shape& AIS_Relation::SecondShape ( ) const
inline

Returns the second shape.

◆ SetArrowSize()

void AIS_Relation::SetArrowSize ( const Standard_Real  theArrowSize)
inline

Allows you to provide settings for the size of the arrow theArrowSize identifying the relation between the two shapes.

◆ SetAutomaticPosition()

void AIS_Relation::SetAutomaticPosition ( const Standard_Boolean  theStatus)
inline

◆ SetBndBox()

void AIS_Relation::SetBndBox ( const Standard_Real  theXmin,
const Standard_Real  theYmin,
const Standard_Real  theZmin,
const Standard_Real  theXmax,
const Standard_Real  theYmax,
const Standard_Real  theZmax 
)
inline

◆ SetColor()

void AIS_Relation::SetColor ( const Quantity_Color theColor)
overridevirtual

Allows you to provide settings for the color theColor of the lines representing the relation between the two shapes.

Reimplemented from AIS_InteractiveObject.

◆ SetExtShape()

void AIS_Relation::SetExtShape ( const Standard_Integer  theIndex)
inline

Allows you to set the status of the extension shape by the index aIndex. The status will be one of the following:

  • 0 - there is no connection to a shape;
  • 1 - there is a connection to the first shape;
  • 2 - there is a connection to the second shape.

◆ SetFirstShape()

virtual void AIS_Relation::SetFirstShape ( const TopoDS_Shape aFShape)
virtual

◆ SetPlane()

void AIS_Relation::SetPlane ( const Handle< Geom_Plane > &  thePlane)
inline

Allows you to set the plane thePlane. This is used to define relations and dimensions in several daughter classes.

◆ SetPosition()

void AIS_Relation::SetPosition ( const gp_Pnt thePosition)
inline

Allows you to provide the objects in the relation with settings for a non-default position.

◆ SetSecondShape()

virtual void AIS_Relation::SetSecondShape ( const TopoDS_Shape aSShape)
virtual

Allows you to identify the second shape aSShape relative to the first.

◆ SetSymbolPrs()

void AIS_Relation::SetSymbolPrs ( const DsgPrs_ArrowSide  theSymbolPrs)
inline

Allows you to provide settings for the symbol presentation.

◆ SetText()

void AIS_Relation::SetText ( const TCollection_ExtendedString theText)
inline

Allows you to provide the settings theText for text aspect.

◆ SetValue()

void AIS_Relation::SetValue ( const Standard_Real  theVal)
inline

Allows you to provide settings for the value theVal for each object in the relation.

◆ SymbolPrs()

DsgPrs_ArrowSide AIS_Relation::SymbolPrs ( ) const
inline

Returns the value of the symbol presentation. This will be one of:

  • AS_NONE - none
  • AS_FIRSTAR - first arrow
  • AS_LASTAR - last arrow
  • AS_BOTHAR - both arrows
  • AS_FIRSTPT - first point
  • AS_LASTPT - last point
  • AS_BOTHPT - both points
  • AS_FIRSTAR_LASTPT - first arrow, last point
  • AS_FIRSTPT_LASTAR - first point, last arrow

◆ Text()

const TCollection_ExtendedString& AIS_Relation::Text ( ) const
inline

Returns settings for text aspect.

◆ Type()

virtual AIS_KindOfInteractive AIS_Relation::Type ( ) const
inlineoverridevirtual

Returns the kind of Interactive Object:

  • None
  • Datum
  • Relation
  • Object By default, the interactive object has a None type. Because specific shapes entail different behavior according to their sub-shapes, you may need to create a Local Context. This will allow you to specify the additional characteristics which you need to handle these shapes.

Reimplemented from AIS_InteractiveObject.

◆ UnsetBndBox()

void AIS_Relation::UnsetBndBox ( )
inline

◆ UnsetColor()

void AIS_Relation::UnsetColor ( )
overridevirtual

Allows you to remove settings for the color of the lines representing the relation between the two shapes.

Reimplemented from AIS_InteractiveObject.

◆ Value()

Standard_Real AIS_Relation::Value ( ) const
inline

Returns the value of each object in the relation.

Field Documentation

◆ myArrowSize

Standard_Real AIS_Relation::myArrowSize
protected

◆ myArrowSizeIsDefined

Standard_Boolean AIS_Relation::myArrowSizeIsDefined
protected

◆ myAutomaticPosition

Standard_Boolean AIS_Relation::myAutomaticPosition
protected

◆ myBndBox

Bnd_Box AIS_Relation::myBndBox
protected

◆ myExtShape

Standard_Integer AIS_Relation::myExtShape
protected

◆ myFirstBasisSurf

Handle< Geom_Surface > AIS_Relation::myFirstBasisSurf
protected

◆ myFirstOffset

Standard_Real AIS_Relation::myFirstOffset
protected

◆ myFirstPlane

gp_Pln AIS_Relation::myFirstPlane
protected

◆ myFirstSurfType

AIS_KindOfSurface AIS_Relation::myFirstSurfType
protected

◆ myFShape

TopoDS_Shape AIS_Relation::myFShape
protected

◆ myIsSetBndBox

Standard_Boolean AIS_Relation::myIsSetBndBox
protected

◆ myPlane

Handle< Geom_Plane > AIS_Relation::myPlane
protected

◆ myPosition

gp_Pnt AIS_Relation::myPosition
protected

◆ mySecondBasisSurf

Handle< Geom_Surface > AIS_Relation::mySecondBasisSurf
protected

◆ mySecondOffset

Standard_Real AIS_Relation::mySecondOffset
protected

◆ mySecondPlane

gp_Pln AIS_Relation::mySecondPlane
protected

◆ mySecondSurfType

AIS_KindOfSurface AIS_Relation::mySecondSurfType
protected

◆ mySShape

TopoDS_Shape AIS_Relation::mySShape
protected

◆ mySymbolPrs

DsgPrs_ArrowSide AIS_Relation::mySymbolPrs
protected

◆ myText

TCollection_ExtendedString AIS_Relation::myText
protected

◆ myVal

Standard_Real AIS_Relation::myVal
protected

The documentation for this class was generated from the following file: