Create a selectable trihedron The trihedron includes 1 origin, 3 axes and 3 labels. Default text of labels are "X", "Y", "Z". Color of origin and any axis, color of arrows and labels may be changed. Visual presentation might be shown in two, shaded and wireframe modes, wireframe by default). There are 4 modes of selection: More...

#include <AIS_Trihedron.hxx>

Inheritance diagram for AIS_Trihedron:

[legend]

Public Member Functions
	AIS_Trihedron (const Handle< Geom_Axis2Placement > &theComponent)
	Initializes a trihedron entity.

Prs3d_DatumMode	DatumDisplayMode () const
	Returns datum display mode.

void	SetDatumDisplayMode (Prs3d_DatumMode theMode)
	Sets Shading or Wireframe display mode, triangle or segment graphic group is used relatively.

const Handle< Geom_Axis2Placement > &	Component () const
	Returns the right-handed coordinate system set in SetComponent.

void	SetComponent (const Handle< Geom_Axis2Placement > &theComponent)
	Constructs the right-handed coordinate system aComponent.

Standard_Boolean	HasOwnSize () const
	Returns true if the trihedron object has a size other than the default size of 100 mm. along each axis.

Standard_Real	Size () const
	Returns the size of trihedron object; 100.0 by DEFAULT.

void	SetSize (const Standard_Real theValue)
	Sets the size of trihedron object.

void	UnsetSize ()
	Removes any non-default settings for size of this trihedron object. If the object has 1 color, the default size of the drawer is reproduced, otherwise DatumAspect becomes null.

Standard_Boolean	HasTextColor () const
	Returns true if trihedron has own text color.

Quantity_Color	TextColor () const
	Returns trihedron text color.

void	SetTextColor (const Quantity_Color &theColor)
	Sets color of label of trihedron axes.

void	SetTextColor (const Prs3d_DatumParts thePart, const Quantity_Color &theColor)
	Sets color of label of trihedron axis.

Standard_Boolean	HasArrowColor () const
	Returns true if trihedron has own arrow color.

Quantity_Color	ArrowColor () const
	Returns trihedron arrow color.

void	SetArrowColor (const Quantity_Color &theColor)
	Sets color of arrow of trihedron axes.

void	SetArrowColor (const Prs3d_DatumParts thePart, const Quantity_Color &theColor)
	Sets color of arrow of trihedron axes.

Quantity_Color	DatumPartColor (Prs3d_DatumParts thePart)
	Returns color of datum part: origin or some of trihedron axes.

void	SetDatumPartColor (const Prs3d_DatumParts thePart, const Quantity_Color &theColor)
	Sets color of datum part: origin or some of trihedron axes. If presentation is shading mode, this color is set for both sides of facing model.

void	SetOriginColor (const Quantity_Color &theColor)
	Sets color of origin. Standard_DEPRECATED("This method is deprecated - SetColor() should be called instead")

void	SetXAxisColor (const Quantity_Color &theColor)
	Sets color of x-axis. Standard_DEPRECATED("This method is deprecated - SetColor() should be called instead")

void	SetYAxisColor (const Quantity_Color &theColor)
	Sets color of y-axis. Standard_DEPRECATED("This method is deprecated - SetColor() should be called instead")

void	SetAxisColor (const Quantity_Color &theColor)
	Sets color of z-axis. Standard_DEPRECATED("This method is deprecated - SetColor() should be called instead")

Standard_Boolean	ToDrawArrows () const
	Returns true if arrows are to be drawn.

void	SetDrawArrows (const Standard_Boolean theToDraw)
	Sets whether to draw the arrows in visualization.

Standard_Integer	SelectionPriority (Prs3d_DatumParts thePart)
	Returns priority of selection for owner of the given type.

void	SetSelectionPriority (Prs3d_DatumParts thePart, Standard_Integer thePriority)
	Sets priority of selection for owner of the given type.

const TCollection_ExtendedString &	Label (Prs3d_DatumParts thePart)
	Returns text of axis. Parameter thePart should be XAxis, YAxis or ZAxis.

void	SetLabel (const Prs3d_DatumParts thePart, const TCollection_ExtendedString &theName)
	Sets text label for trihedron axis. Parameter thePart should be XAxis, YAxis or ZAxis.

virtual void	SetColor (const Quantity_Color &theColor) override
	Sets the color theColor for this trihedron object, it changes color of axes.

virtual Standard_Boolean	AcceptDisplayMode (const Standard_Integer theMode) const override
	Returns true if the display mode selected, aMode, is valid for trihedron datums.

virtual Standard_Integer	Signature () const override
	Returns index 3, selection of the planes XOY, YOZ, XOZ.

virtual AIS_KindOfInteractive	Type () const override
	Indicates that the type of Interactive Object is datum.

virtual void	UnsetColor () override
	Removes the settings for color.

virtual void	ClearSelected () override
	Method which clear all selected owners belonging to this selectable object ( for fast presentation draw ).

virtual void	HilightSelected (const Handle< PrsMgr_PresentationManager > &thePM, const SelectMgr_SequenceOfOwner &theOwners) override
	Method which draws selected owners ( for fast presentation draw ).

virtual void	HilightOwnerWithColor (const Handle< PrsMgr_PresentationManager > &thePM, const Handle< Prs3d_Drawer > &theStyle, const Handle< SelectMgr_EntityOwner > &theOwner) override
	Method which hilight an owner belonging to this selectable object ( for fast presentation draw ).

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.

Standard_Boolean	HasInteractiveContext () const
	Indicates whether the Interactive Object has a pointer to an interactive context.

AIS_InteractiveContext *	InteractiveContext () const
	Returns the context pointer to the interactive context.

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.

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.

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:

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.

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.

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.

Handle< AIS_InteractiveContext >	GetContext () const
	Returns the context pointer to the interactive context.

Standard_Boolean	HasPresentation () const
	Returns TRUE when this object has a presentation in the current DisplayMode()

Handle< Prs3d_Presentation >	Presentation () const
	Returns the current presentation of this object according to the current DisplayMode()

void	SetAspect (const Handle< Prs3d_BasicAspect > &anAspect)
	Sets the graphic basic aspect to the current presentation.

Public Member Functions inherited from SelectMgr_SelectableObject
virtual	~SelectMgr_SelectableObject ()
	Clears all selections of the object.

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.

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.

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.

void	AddSelection (const Handle< SelectMgr_Selection > &aSelection, const Standard_Integer aMode)
	Adds the selection aSelection with the selection mode index aMode to this framework.

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.

const Handle< SelectMgr_Selection > &	Selection (const Standard_Integer theMode) const
	Returns the selection having specified selection mode or NULL.

Standard_Boolean	HasSelection (const Standard_Integer theMode) const
	Returns true if a selection corresponding to the selection mode theMode was computed for this object.

const SelectMgr_SequenceOfSelection &	Selections () const
	Return the sequence of selections.

void	ResetTransformation () override
	resets local transformation to identity.

virtual void	UpdateTransformation () override
	Recomputes the location of the selection aSelection.

virtual void	UpdateTransformations (const Handle< SelectMgr_Selection > &aSelection)
	Updates locations in all sensitive entities from <aSelection> and in corresponding entity owners.

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.

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.

virtual void	SetAutoHilight (const Standard_Boolean theAutoHilight)
	Set AutoHilight property to true or false.

Handle< Prs3d_Presentation >	GetHilightPresentation (const Handle< PrsMgr_PresentationManager > &thePrsMgr)
	Creates or returns existing presentation for highlighting detected object.

Handle< Prs3d_Presentation >	GetSelectPresentation (const Handle< PrsMgr_PresentationManager > &thePrsMgr)
	Creates or returns existing presentation for highlighting selected object.

virtual void	ErasePresentations (Standard_Boolean theToRemove)
	Removes presentations returned by GetHilightPresentation() and GetSelectPresentation().

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.

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.

void	SetAssemblyOwner (const Handle< SelectMgr_EntityOwner > &theOwner, const Standard_Integer theMode=-1)
	Sets common entity owner for assembly sensitive object entities.

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.

Standard_Integer	GlobalSelectionMode () const
	Returns the mode for selection of object as a whole; 0 by default.

virtual Handle< SelectMgr_EntityOwner >	GlobalSelOwner () const
	Returns the owner of mode for selection of object as a whole.

virtual const Handle< SelectMgr_EntityOwner > &	GetAssemblyOwner () const
	Returns common entity owner if the object is an assembly.

Public Member Functions inherited from PrsMgr_PresentableObject
PrsMgr_Presentations &	Presentations ()
	Return presentations.

Graphic3d_ZLayerId	ZLayer () const
	Get ID of Z layer for main presentation.

Standard_Boolean	IsMutable () const
	Returns true if object has mutable nature (content or location are be changed regularly). Mutable object will be managed in different way than static onces (another optimizations).

virtual void	SetMutable (const Standard_Boolean theIsMutable)
	Sets if the object has mutable nature (content or location will be changed regularly). This method should be called before object displaying to take effect.

const Handle< Graphic3d_ViewAffinity > &	ViewAffinity () const
	Return view affinity mask.

Standard_Boolean	HasDisplayMode () const
	Returns true if the Interactive Object has display mode setting overriding global setting (within Interactive Context).

Standard_Integer	DisplayMode () const
	Returns the display mode setting of the Interactive Object. The range of supported display mode indexes should be specified within object definition and filtered by AccepDisplayMode().

void	SetDisplayMode (const Standard_Integer theMode)
	Sets the display mode for the interactive object. An object can have its own temporary display mode, which is different from that proposed by the interactive context.

void	UnsetDisplayMode ()
	Removes display mode settings from the interactive object.

Standard_Boolean	HasHilightMode () const
	Returns true if the Interactive Object is in highlight mode.

Standard_Integer	HilightMode () const
	Returns highlight display mode. This is obsolete method for backward compatibility - use HilightAttributes() and DynamicHilightAttributes() instead.

void	SetHilightMode (const Standard_Integer theMode)
	Sets highlight display mode. This is obsolete method for backward compatibility - use HilightAttributes() and DynamicHilightAttributes() instead.

void	UnsetHilightMode ()
	Unsets highlight display mode.

virtual Standard_Integer	DefaultDisplayMode () const
	Returns the default display mode.

Standard_Boolean	ToBeUpdated (Standard_Boolean theToIncludeHidden=Standard_False) const
	Returns TRUE if any active presentation has invalidation flag.

void	SetToUpdate (Standard_Integer theMode)
	Flags presentation to be updated; UpdatePresentations() will recompute these presentations.

void	SetToUpdate ()
	flags all the Presentations to be Updated.

Standard_Boolean	IsInfinite () const
	Returns true if the interactive object is infinite; FALSE by default. This flag affects various operations operating on bounding box of graphic presentations of this object. For instance, infinite objects are not taken in account for View FitAll. This does not necessarily means that object is actually infinite, auxiliary objects might be also marked with this flag to achieve desired behavior.

void	SetInfiniteState (const Standard_Boolean theFlag=Standard_True)
	Sets if object should be considered as infinite.

PrsMgr_TypeOfPresentation3d	TypeOfPresentation3d () const
	Returns information on whether the object accepts display in HLR mode or not.

void	SetTypeOfPresentation (const PrsMgr_TypeOfPresentation3d theType)
	Set type of presentation.

PrsMgr_DisplayStatus	DisplayStatus () const
	Return presentation display status; PrsMgr_DisplayStatus_None by default.

const Handle< Prs3d_Drawer > &	Attributes () const
	Returns the attributes settings.

virtual void	SetAttributes (const Handle< Prs3d_Drawer > &theDrawer)
	Initializes the drawing tool theDrawer.

const Handle< Prs3d_Drawer > &	HilightAttributes () const
	Returns the hilight attributes settings. When not NULL, overrides both Prs3d_TypeOfHighlight_LocalSelected and Prs3d_TypeOfHighlight_Selected defined within AIS_InteractiveContext::HighlightStyle().

virtual void	SetHilightAttributes (const Handle< Prs3d_Drawer > &theDrawer)
	Initializes the hilight drawing tool theDrawer.

const Handle< Prs3d_Drawer > &	DynamicHilightAttributes () const
	Returns the hilight attributes settings. When not NULL, overrides both Prs3d_TypeOfHighlight_LocalDynamic and Prs3d_TypeOfHighlight_Dynamic defined within AIS_InteractiveContext::HighlightStyle().

virtual void	SetDynamicHilightAttributes (const Handle< Prs3d_Drawer > &theDrawer)
	Initializes the dynamic hilight drawing tool.

virtual void	UnsetHilightAttributes ()
	Clears settings provided by the hilight drawing tool theDrawer.

void	SynchronizeAspects ()
	Synchronize presentation aspects after their modification.

const Handle< Graphic3d_TransformPers > &	TransformPersistence () const
	Returns Transformation Persistence defining a special Local Coordinate system where this presentable object is located or NULL handle if not defined. Position of the object having Transformation Persistence is mutable and depends on camera position. The same applies to a bounding box of the object.

virtual void	SetTransformPersistence (const Handle< Graphic3d_TransformPers > &theTrsfPers)
	Sets up Transform Persistence defining a special Local Coordinate system where this object should be located. Note that management of Transform Persistence object is more expensive than of the normal one, because it requires its position being recomputed basing on camera position within each draw call / traverse.

const Handle< TopLoc_Datum3D > &	LocalTransformationGeom () const
	Return the local transformation. Note that the local transformation of the object having Transformation Persistence is applied within Local Coordinate system defined by this Persistence.

void	SetLocalTransformation (const gp_Trsf &theTrsf)
	Sets local transformation to theTransformation. Note that the local transformation of the object having Transformation Persistence is applied within Local Coordinate system defined by this Persistence.

void	SetLocalTransformation (const Handle< TopLoc_Datum3D > &theTrsf)
	Sets local transformation to theTransformation. Note that the local transformation of the object having Transformation Persistence is applied within Local Coordinate system defined by this Persistence.

Standard_Boolean	HasTransformation () const
	Returns true if object has a transformation that is different from the identity.

const Handle< TopLoc_Datum3D > &	TransformationGeom () const
	Return the transformation taking into account transformation of parent object(s). Note that the local transformation of the object having Transformation Persistence is applied within Local Coordinate system defined by this Persistence.

const gp_Trsf &	LocalTransformation () const
	Return the local transformation. Note that the local transformation of the object having Transformation Persistence is applied within Local Coordinate system defined by this Persistence.

const gp_Trsf &	Transformation () const
	Return the transformation taking into account transformation of parent object(s). Note that the local transformation of the object having Transformation Persistence is applied within Local Coordinate system defined by this Persistence.

const gp_GTrsf &	InversedTransformation () const
	Return inversed transformation.

const Handle< TopLoc_Datum3D > &	CombinedParentTransformation () const
	Return combined parent transformation.

const Handle< Graphic3d_SequenceOfHClipPlane > &	ClipPlanes () const
	Get clip planes.

virtual void	SetClipPlanes (const Handle< Graphic3d_SequenceOfHClipPlane > &thePlanes)
	Set clip planes for graphical clipping for all display mode presentations. The composition of clip planes truncates the rendering space to convex volume. Please be aware that number of supported clip plane is limited. The planes which exceed the limit are ignored. Besides of this, some planes can be already set in view where the object is shown: the number of these planes should be subtracted from limit to predict the maximum possible number of object clipping planes.

virtual void	AddClipPlane (const Handle< Graphic3d_ClipPlane > &thePlane)
	Adds clip plane for graphical clipping for all display mode presentations. The composition of clip planes truncates the rendering space to convex volume. Please be aware that number of supported clip plane is limited. The planes which exceed the limit are ignored. Besides of this, some planes can be already set in view where the object is shown: the number of these planes should be subtracted from limit to predict the maximum possible number of object clipping planes.

virtual void	RemoveClipPlane (const Handle< Graphic3d_ClipPlane > &thePlane)
	Removes previously added clip plane.

PrsMgr_PresentableObject *	Parent () const
	Returns parent of current object in scene hierarchy.

const PrsMgr_ListOfPresentableObjects &	Children () const
	Returns children of the current object.

virtual void	AddChild (const Handle< PrsMgr_PresentableObject > &theObject)
	Makes theObject child of current object in scene hierarchy.

void	AddChildWithCurrentTransformation (const Handle< PrsMgr_PresentableObject > &theObject)
	Makes theObject child of current object in scene hierarchy with keeping the current global transformation So the object keeps the same position/orientation in the global CS.

virtual void	RemoveChild (const Handle< PrsMgr_PresentableObject > &theObject)
	Removes theObject from children of current object in scene hierarchy.

void	RemoveChildWithRestoreTransformation (const Handle< PrsMgr_PresentableObject > &theObject)
	Removes theObject from children of current object in scene hierarchy with keeping the current global transformation. So the object keeps the same position/orientation in the global CS.

Standard_Boolean	HasOwnPresentations () const
	Returns true if object should have own presentations.

virtual void	BoundingBox (Bnd_Box &theBndBox)
	Returns bounding box of object correspondingly to its current display mode. This method requires presentation to be already computed, since it relies on bounding box of presentation structures, which are supposed to be same/close amongst different display modes of this object.

void	SetIsoOnTriangulation (const Standard_Boolean theIsEnabled)
	Enables or disables on-triangulation build of isolines according to the flag given.

Aspect_TypeOfFacingModel	CurrentFacingModel () const
	Returns the current facing model which is in effect.

void	SetCurrentFacingModel (const Aspect_TypeOfFacingModel theModel=Aspect_TOFM_BOTH_SIDE)
	change the current facing model apply on polygons for SetColor(), SetTransparency(), SetMaterial() methods default facing model is Aspect_TOFM_TWO_SIDE. This mean that attributes is applying both on the front and back face.

Standard_Boolean	HasColor () const
	Returns true if the Interactive Object has color.

virtual void	Color (Quantity_Color &theColor) const
	Returns the color setting of the Interactive Object.

Standard_Boolean	HasWidth () const
	Returns true if the Interactive Object has width.

Standard_Real	Width () const
	Returns the width setting of the Interactive Object.

virtual void	SetWidth (const Standard_Real theWidth)
	Allows you to provide the setting aValue for width. Only the Interactive Object knows which Drawer attribute is affected by the width setting.

virtual void	UnsetWidth ()
	Reset width to default value.

Standard_Boolean	HasMaterial () const
	Returns true if the Interactive Object has a setting for material.

virtual Graphic3d_NameOfMaterial	Material () const
	Returns the current material setting as enumeration value.

virtual void	SetMaterial (const Graphic3d_MaterialAspect &aName)
	Sets the material aMat defining this display attribute for the interactive object. Material aspect determines shading aspect, color and transparency of visible entities.

virtual void	UnsetMaterial ()
	Removes the setting for material.

Standard_Boolean	IsTransparent () const
	Returns true if there is a transparency setting.

virtual Standard_Real	Transparency () const
	Returns the transparency setting. This will be between 0.0 and 1.0. At 0.0 an object will be totally opaque, and at 1.0, fully transparent.

virtual void	SetTransparency (const Standard_Real aValue=0.6)
	Attributes a setting aValue for transparency. The transparency value should be between 0.0 and 1.0. At 0.0 an object will be totally opaque, and at 1.0, fully transparent. Warning At a value of 1.0, there may be nothing visible.

virtual void	UnsetTransparency ()
	Removes the transparency setting. The object is opaque by default.

virtual Standard_Boolean	HasPolygonOffsets () const
	Returns Standard_True if <myDrawer> has non-null shading aspect.

virtual void	PolygonOffsets (Standard_Integer &aMode, Standard_ShortReal &aFactor, Standard_ShortReal &aUnits) const
	Retrieves current polygon offsets settings from <myDrawer>.

virtual void	SetPolygonOffsets (const Standard_Integer aMode, const Standard_ShortReal aFactor=1.0, const Standard_ShortReal aUnits=0.0)
	Sets up polygon offsets for this object.

virtual void	UnsetAttributes ()
	Clears settings provided by the drawing tool aDrawer.

void	ToBeUpdated (TColStd_ListOfInteger &ListOfMode) const
	gives the list of modes which are flagged "to be updated".

Standard_Boolean	ToPropagateVisualState () const
	Get value of the flag "propagate visual state" It means that the display/erase/color visual state is propagated automatically to all children; by default, the flag is true.

void	SetPropagateVisualState (const Standard_Boolean theFlag)
	Change the value of the flag "propagate visual state".

Public Member Functions inherited from Standard_Transient
	Standard_Transient ()
	Empty constructor.

	Standard_Transient (const Standard_Transient &)
	Copy constructor – does nothing.

Standard_Transient &	operator= (const Standard_Transient &)
	Assignment operator, needed to avoid copying reference counter.

virtual	~Standard_Transient ()
	Destructor must be virtual.

virtual const opencascade::handle< Standard_Type > &	DynamicType () const
	Returns a type descriptor about this object.

Standard_Boolean	IsInstance (const opencascade::handle< Standard_Type > &theType) const
	Returns a true value if this is an instance of Type.

Standard_Boolean	IsInstance (const Standard_CString theTypeName) const
	Returns a true value if this is an instance of TypeName.

Standard_Boolean	IsKind (const opencascade::handle< Standard_Type > &theType) const
	Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism.

Standard_Boolean	IsKind (const Standard_CString theTypeName) const
	Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism.

Standard_Transient *	This () const
	Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero.

Standard_Integer	GetRefCount () const noexcept
	Get the reference counter of this object.

void	IncrementRefCounter () noexcept
	Increments the reference counter of this object.

Standard_Integer	DecrementRefCounter () noexcept
	Decrements the reference counter of this object; returns the decremented value.

virtual void	Delete () const
	Memory deallocator for transient classes.

Protected Member Functions
void	Compute (const Handle< PrsMgr_PresentationManager > &thePrsMgr, const Handle< Prs3d_Presentation > &thePrs, const Standard_Integer theMode) override
	Compute trihedron presentation.

virtual void	ComputeSelection (const Handle< SelectMgr_Selection > &theSelection, const Standard_Integer theMode) override
	Compute selection.

virtual void	DumpJson (Standard_OStream &theOStream, Standard_Integer theDepth=-1) const override
	Dumps the content of me into the stream.

Handle< Select3D_SensitiveEntity >	createSensitiveEntity (const Prs3d_DatumParts thePart, const Handle< SelectMgr_EntityOwner > &theOwner) const
	Creates a sensitive entity for the datum part that will be used in selection owner creation.

void	computePresentation (const Handle< PrsMgr_PresentationManager > &thePrsMgr, const Handle< Prs3d_Presentation > &thePrs)
	Computes presentation for display mode equal 1.

void	setOwnDatumAspect ()
	Returns own datum aspect of trihedron, create this aspect if it was not created yet.

const Handle< Graphic3d_ArrayOfPrimitives > &	arrayOfPrimitives (Prs3d_DatumParts thePart) const
	Returns primitives.

void	updatePrimitives (const Handle< Prs3d_DatumAspect > &theAspect, Prs3d_DatumMode theMode, const gp_Pnt &theOrigin, const gp_Dir &theXDir, const gp_Dir &theYDir, const gp_Dir &theZDir)
	Updates graphic groups for the current datum mode Parameters of datum position and orientation.

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.

void	SetDisplayStatus (PrsMgr_DisplayStatus theStatus)
	Set presentation display status.

Protected Member Functions inherited from SelectMgr_SelectableObject
	SelectMgr_SelectableObject (const PrsMgr_TypeOfPresentation3d aTypeOfPresentation3d=PrsMgr_TOP_AllView)
	Protected empty constructor.

void	setGlobalSelMode (const Standard_Integer theMode)
	Override global selection mode.

virtual void	UpdateClipping () override
	Update clipping planes state.

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.

Protected Member Functions inherited from PrsMgr_PresentableObject
void	Update (Standard_Boolean theToIncludeHidden=Standard_False)
	Recomputes all presentations of the object.

void	Update (Standard_Integer theMode, Standard_Boolean theToClearOther)
	Recomputes the presentation in the given mode.

	PrsMgr_PresentableObject (const PrsMgr_TypeOfPresentation3d aTypeOfPresentation3d=PrsMgr_TOP_AllView)
	Protected empty constructor.

virtual	~PrsMgr_PresentableObject ()
	Destructor.

virtual void	Fill (const Handle< PrsMgr_PresentationManager > &thePrsMgr, const Handle< PrsMgr_Presentation > &thePrs, const Standard_Integer theMode)
	Fills the given 3D view presentation for specified display mode using Compute() method. In addition, configures other properties of presentation (transformation, clipping planes).

virtual void	computeHLR (const Handle< Graphic3d_Camera > &theProjector, const Handle< TopLoc_Datum3D > &theTrsf, const Handle< Prs3d_Presentation > &thePrs)
	Calculates hidden line removal presentation for specific camera position. Each of the views in the viewer and every modification such as rotation, for example, entails recalculation. Default implementation throws Standard_NotImplemented exception Warning! The transformation must be applied to the object before computation.

Standard_Boolean	UpdatePresentations (Standard_Boolean theToIncludeHidden=Standard_False)
	Recomputes invalidated presentations of the object.

virtual void	SetCombinedParentTransform (const Handle< TopLoc_Datum3D > &theTrsf)
	Sets myCombinedParentTransform to theTransformation. Thus object receives transformation from parent node and able to derive its own.

virtual void	setLocalTransformation (const Handle< TopLoc_Datum3D > &theTransformation)
	Sets local transformation to theTransformation.

void	recomputeComputed () const
	Recompute computed (HLR) presentations (when view is in computed mode).

void	replaceAspects (const Graphic3d_MapOfAspectsToAspects &theMap)
	Replace aspects of existing (computed) presentation groups, so that the new aspects can be applied without recomputing presentation. It is NOT recommended approach, because user has to fill such map and then search for each occurrence in computed groups. The recommended approach is computing presentation with necessary customized aspects, and then modify them directly followed by SynchronizeAspects() call.

Protected Attributes
Handle< Geom_Axis2Placement >	myComponent

Prs3d_DatumMode	myTrihDispMode

Standard_Boolean	myHasOwnSize

Standard_Boolean	myHasOwnTextColor

Standard_Boolean	myHasOwnArrowColor

TCollection_ExtendedString	myLabels [Prs3d_DatumParts_NB]

Standard_Integer	mySelectionPriority [Prs3d_DatumParts_NB]

Handle< Graphic3d_Group >	myPartToGroup [Prs3d_DatumParts_NB]

NCollection_List< Prs3d_DatumParts >	mySelectedParts

Handle< Graphic3d_AspectLine3d >	myHiddenLineAspect

Handle< Graphic3d_ArrayOfPrimitives >	myPrimitives [Prs3d_DatumParts_NB]

Protected Attributes inherited from AIS_InteractiveObject
AIS_InteractiveContext *	myCTXPtr
	pointer to Interactive Context, where object is currently displayed;

Handle< Standard_Transient >	myOwner
	application-specific owner object

Protected Attributes inherited from SelectMgr_SelectableObject
SelectMgr_SequenceOfSelection	myselections
	list of selections

Handle< Prs3d_Presentation >	mySelectionPrs
	optional presentation for highlighting selected object

Handle< Prs3d_Presentation >	myHilightPrs
	optional presentation for highlighting detected object

Standard_Integer	myGlobalSelMode
	global selection mode

Standard_Boolean	myAutoHilight
	auto-highlighting flag defining

Protected Attributes inherited from PrsMgr_PresentableObject
PrsMgr_PresentableObject *	myParent
	pointer to the parent object

PrsMgr_Presentations	myPresentations
	list of presentations

Handle< Graphic3d_ViewAffinity >	myViewAffinity
	view affinity mask

Handle< Graphic3d_SequenceOfHClipPlane >	myClipPlanes
	sequence of object-specific clipping planes

Handle< Prs3d_Drawer >	myDrawer
	main presentation attributes

Handle< Prs3d_Drawer >	myHilightDrawer
	(optional) custom presentation attributes for highlighting selected object

Handle< Prs3d_Drawer >	myDynHilightDrawer
	(optional) custom presentation attributes for highlighting detected object

Handle< Graphic3d_TransformPers >	myTransformPersistence
	transformation persistence

Handle< TopLoc_Datum3D >	myLocalTransformation
	local transformation relative to parent object

Handle< TopLoc_Datum3D >	myTransformation
	absolute transformation of this object (combined parents + local transformations)

Handle< TopLoc_Datum3D >	myCombinedParentTransform
	transformation of parent object (combined for all parents)

PrsMgr_ListOfPresentableObjects	myChildren
	list of children

gp_GTrsf	myInvTransformation
	inversion of absolute transformation (combined parents + local transformations)

PrsMgr_TypeOfPresentation3d	myTypeOfPresentation3d
	presentation type

PrsMgr_DisplayStatus	myDisplayStatus
	presentation display status

Aspect_TypeOfFacingModel	myCurrentFacingModel
	current facing model

Standard_ShortReal	myOwnWidth
	custom width value

Standard_Boolean	hasOwnColor
	own color flag

Standard_Boolean	hasOwnMaterial
	own material flag

Standard_Boolean	myInfiniteState
	infinite flag

Standard_Boolean	myIsMutable
	mutable flag

Standard_Boolean	myHasOwnPresentations
	flag indicating if object should have own presentations

Standard_Boolean	myToPropagateVisualState
	flag indicating if visual state (display/erase/color) should be propagated to all children

Additional Inherited Members
Public Types inherited from Standard_Transient
typedef void	base_type
	Returns a type descriptor about this object.

Static Public Member Functions inherited from Standard_Transient
static constexpr const char *	get_type_name ()
	Returns a type descriptor about this object.

static const opencascade::handle< Standard_Type > &	get_type_descriptor ()
	Returns type descriptor of Standard_Transient class.

Static Protected Member Functions inherited from PrsMgr_PresentableObject
static const gp_Trsf &	getIdentityTrsf ()
	Return the identity transformation.

Detailed Description

Create a selectable trihedron The trihedron includes 1 origin, 3 axes and 3 labels. Default text of labels are "X", "Y", "Z". Color of origin and any axis, color of arrows and labels may be changed. Visual presentation might be shown in two, shaded and wireframe modes, wireframe by default). There are 4 modes of selection:

AIS_TrihedronSelectionMode_EntireObject to select trihedron, priority = 1
AIS_TrihedronSelectionMode_Origin to select its origin, priority = 5
AIS_TrihedronSelectionMode_Axes to select its axis, priority = 3
AIS_TrihedronSelectionMode_MainPlanes to select its planes, priority = 2

Warning! For the presentation of trihedron, the default unit of length is the millimetre, and the default value for the representation of the axes is 100. If you modify these dimensions, you must temporarily recover the Drawer. From inside it, you take the aspect in which the values for length are stocked. For trihedron, this is Prs3d_Drawer_LineAspect. You change the values inside this Aspect and recalculate the presentation.

Constructor & Destructor Documentation

◆ AIS_Trihedron()

AIS_Trihedron::AIS_Trihedron ( const Handle< Geom_Axis2Placement > & theComponent )

Initializes a trihedron entity.

Member Function Documentation

◆ AcceptDisplayMode()

virtual Standard_Boolean AIS_Trihedron::AcceptDisplayMode ( const Standard_Integer theMode ) const

inlineoverridevirtual

Returns true if the display mode selected, aMode, is valid for trihedron datums.

Reimplemented from PrsMgr_PresentableObject.

◆ arrayOfPrimitives()

const Handle< Graphic3d_ArrayOfPrimitives > & AIS_Trihedron::arrayOfPrimitives ( Prs3d_DatumParts thePart ) const

inlineprotected

Returns primitives.

◆ ArrowColor()

Quantity_Color AIS_Trihedron::ArrowColor ( ) const

Returns trihedron arrow color.

◆ ClearSelected()

virtual void AIS_Trihedron::ClearSelected ( )

overridevirtual

Method which clear all selected owners belonging to this selectable object ( for fast presentation draw ).

Reimplemented from SelectMgr_SelectableObject.

◆ Component()

const Handle< Geom_Axis2Placement > & AIS_Trihedron::Component ( ) const

inline

Returns the right-handed coordinate system set in SetComponent.

◆ Compute()

void AIS_Trihedron::Compute	(	const Handle< PrsMgr_PresentationManager > &	thePrsMgr,
		const Handle< Prs3d_Presentation > &	thePrs,
		const Standard_Integer	theMode
	)

overrideprotectedvirtual

Compute trihedron presentation.

Implements PrsMgr_PresentableObject.

◆ computePresentation()

void AIS_Trihedron::computePresentation	(	const Handle< PrsMgr_PresentationManager > &	thePrsMgr,
		const Handle< Prs3d_Presentation > &	thePrs
	)

protected

Computes presentation for display mode equal 1.

◆ ComputeSelection()

virtual void AIS_Trihedron::ComputeSelection	(	const Handle< SelectMgr_Selection > &	theSelection,
		const Standard_Integer	theMode
	)

overrideprotectedvirtual

Compute selection.

Implements SelectMgr_SelectableObject.

◆ createSensitiveEntity()

Handle< Select3D_SensitiveEntity > AIS_Trihedron::createSensitiveEntity	(	const Prs3d_DatumParts	thePart,
		const Handle< SelectMgr_EntityOwner > &	theOwner
	)		const

protected

Creates a sensitive entity for the datum part that will be used in selection owner creation.

◆ DatumDisplayMode()

Prs3d_DatumMode AIS_Trihedron::DatumDisplayMode ( ) const

inline

Returns datum display mode.

◆ DatumPartColor()

Quantity_Color AIS_Trihedron::DatumPartColor ( Prs3d_DatumParts thePart )

Returns color of datum part: origin or some of trihedron axes.

◆ DumpJson()

virtual void AIS_Trihedron::DumpJson	(	Standard_OStream &	theOStream,
		Standard_Integer	theDepth = `-1`
	)		const

overrideprotectedvirtual

Dumps the content of me into the stream.

Reimplemented from AIS_InteractiveObject.

◆ HasArrowColor()

Standard_Boolean AIS_Trihedron::HasArrowColor ( ) const

inline

Returns true if trihedron has own arrow color.

◆ HasOwnSize()

Standard_Boolean AIS_Trihedron::HasOwnSize ( ) const

inline

Returns true if the trihedron object has a size other than the default size of 100 mm. along each axis.

◆ HasTextColor()

Standard_Boolean AIS_Trihedron::HasTextColor ( ) const

inline

Returns true if trihedron has own text color.

◆ HilightOwnerWithColor()

virtual void AIS_Trihedron::HilightOwnerWithColor	(	const Handle< PrsMgr_PresentationManager > &	thePM,
		const Handle< Prs3d_Drawer > &	theStyle,
		const Handle< SelectMgr_EntityOwner > &	theOwner
	)

overridevirtual

Method which hilight an owner belonging to this selectable object ( for fast presentation draw ).

Reimplemented from SelectMgr_SelectableObject.

◆ HilightSelected()

virtual void AIS_Trihedron::HilightSelected	(	const Handle< PrsMgr_PresentationManager > &	thePM,
		const SelectMgr_SequenceOfOwner &	theOwners
	)

overridevirtual

Method which draws selected owners ( for fast presentation draw ).

Reimplemented from SelectMgr_SelectableObject.

◆ Label()

const TCollection_ExtendedString & AIS_Trihedron::Label ( Prs3d_DatumParts thePart )

inline

Returns text of axis. Parameter thePart should be XAxis, YAxis or ZAxis.

◆ SelectionPriority()

Standard_Integer AIS_Trihedron::SelectionPriority ( Prs3d_DatumParts thePart )

inline

Returns priority of selection for owner of the given type.

◆ SetArrowColor() [1/2]

void AIS_Trihedron::SetArrowColor	(	const Prs3d_DatumParts	thePart,
		const Quantity_Color &	theColor
	)

Sets color of arrow of trihedron axes.

◆ SetArrowColor() [2/2]

void AIS_Trihedron::SetArrowColor ( const Quantity_Color & theColor )

Sets color of arrow of trihedron axes.

◆ SetAxisColor()

void AIS_Trihedron::SetAxisColor ( const Quantity_Color & theColor )

Sets color of z-axis. Standard_DEPRECATED("This method is deprecated - SetColor() should be called instead")

◆ SetColor()

virtual void AIS_Trihedron::SetColor ( const Quantity_Color & theColor )

overridevirtual

Sets the color theColor for this trihedron object, it changes color of axes.

Reimplemented from PrsMgr_PresentableObject.

◆ SetComponent()

void AIS_Trihedron::SetComponent ( const Handle< Geom_Axis2Placement > & theComponent )

Constructs the right-handed coordinate system aComponent.

◆ SetDatumDisplayMode()

void AIS_Trihedron::SetDatumDisplayMode ( Prs3d_DatumMode theMode )

inline

Sets Shading or Wireframe display mode, triangle or segment graphic group is used relatively.

◆ SetDatumPartColor()

void AIS_Trihedron::SetDatumPartColor	(	const Prs3d_DatumParts	thePart,
		const Quantity_Color &	theColor
	)

Sets color of datum part: origin or some of trihedron axes. If presentation is shading mode, this color is set for both sides of facing model.

◆ SetDrawArrows()

void AIS_Trihedron::SetDrawArrows ( const Standard_Boolean theToDraw )

Sets whether to draw the arrows in visualization.

◆ SetLabel()

void AIS_Trihedron::SetLabel	(	const Prs3d_DatumParts	thePart,
		const TCollection_ExtendedString &	theName
	)

inline

Sets text label for trihedron axis. Parameter thePart should be XAxis, YAxis or ZAxis.

◆ SetOriginColor()

void AIS_Trihedron::SetOriginColor ( const Quantity_Color & theColor )

Sets color of origin. Standard_DEPRECATED("This method is deprecated - SetColor() should be called instead")

◆ setOwnDatumAspect()

void AIS_Trihedron::setOwnDatumAspect ( )

protected

Returns own datum aspect of trihedron, create this aspect if it was not created yet.

◆ SetSelectionPriority()

void AIS_Trihedron::SetSelectionPriority	(	Prs3d_DatumParts	thePart,
		Standard_Integer	thePriority
	)

inline

Sets priority of selection for owner of the given type.

◆ SetSize()

void AIS_Trihedron::SetSize ( const Standard_Real theValue )

Sets the size of trihedron object.

◆ SetTextColor() [1/2]

void AIS_Trihedron::SetTextColor	(	const Prs3d_DatumParts	thePart,
		const Quantity_Color &	theColor
	)

Sets color of label of trihedron axis.

◆ SetTextColor() [2/2]

void AIS_Trihedron::SetTextColor ( const Quantity_Color & theColor )

Sets color of label of trihedron axes.

◆ SetXAxisColor()

void AIS_Trihedron::SetXAxisColor ( const Quantity_Color & theColor )

Sets color of x-axis. Standard_DEPRECATED("This method is deprecated - SetColor() should be called instead")

◆ SetYAxisColor()

void AIS_Trihedron::SetYAxisColor ( const Quantity_Color & theColor )

Sets color of y-axis. Standard_DEPRECATED("This method is deprecated - SetColor() should be called instead")

◆ Signature()

virtual Standard_Integer AIS_Trihedron::Signature ( ) const

inlineoverridevirtual

Returns index 3, selection of the planes XOY, YOZ, XOZ.

Reimplemented from AIS_InteractiveObject.

◆ Size()

Standard_Real AIS_Trihedron::Size ( ) const

Returns the size of trihedron object; 100.0 by DEFAULT.

◆ TextColor()

Quantity_Color AIS_Trihedron::TextColor ( ) const

Returns trihedron text color.

◆ ToDrawArrows()

Standard_Boolean AIS_Trihedron::ToDrawArrows ( ) const

Returns true if arrows are to be drawn.

◆ Type()

virtual AIS_KindOfInteractive AIS_Trihedron::Type ( ) const

inlineoverridevirtual

Indicates that the type of Interactive Object is datum.

Reimplemented from AIS_InteractiveObject.

◆ UnsetColor()

virtual void AIS_Trihedron::UnsetColor ( )

overridevirtual

Removes the settings for color.

Reimplemented from PrsMgr_PresentableObject.

◆ UnsetSize()

void AIS_Trihedron::UnsetSize ( )

Removes any non-default settings for size of this trihedron object. If the object has 1 color, the default size of the drawer is reproduced, otherwise DatumAspect becomes null.

◆ updatePrimitives()

void AIS_Trihedron::updatePrimitives	(	const Handle< Prs3d_DatumAspect > &	theAspect,
		Prs3d_DatumMode	theMode,
		const gp_Pnt &	theOrigin,
		const gp_Dir &	theXDir,
		const gp_Dir &	theYDir,
		const gp_Dir &	theZDir
	)

protected

Updates graphic groups for the current datum mode Parameters of datum position and orientation.

Field Documentation

◆ myComponent

Handle< Geom_Axis2Placement > AIS_Trihedron::myComponent

protected

◆ myHasOwnArrowColor

Standard_Boolean AIS_Trihedron::myHasOwnArrowColor

protected

◆ myHasOwnSize

Standard_Boolean AIS_Trihedron::myHasOwnSize

protected

◆ myHasOwnTextColor

Standard_Boolean AIS_Trihedron::myHasOwnTextColor

protected

◆ myHiddenLineAspect

Handle< Graphic3d_AspectLine3d > AIS_Trihedron::myHiddenLineAspect

protected

◆ myLabels

TCollection_ExtendedString AIS_Trihedron::myLabels[Prs3d_DatumParts_NB]

protected

◆ myPartToGroup

Handle< Graphic3d_Group > AIS_Trihedron::myPartToGroup[Prs3d_DatumParts_NB]

protected

◆ myPrimitives

Handle< Graphic3d_ArrayOfPrimitives > AIS_Trihedron::myPrimitives[Prs3d_DatumParts_NB]

protected

◆ mySelectedParts

NCollection_List<Prs3d_DatumParts> AIS_Trihedron::mySelectedParts

protected

◆ mySelectionPriority

Standard_Integer AIS_Trihedron::mySelectionPriority[Prs3d_DatumParts_NB]

protected

◆ myTrihDispMode

Prs3d_DatumMode AIS_Trihedron::myTrihDispMode

protected

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

AIS_Trihedron.hxx

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ AIS_Trihedron()

Member Function Documentation

◆ AcceptDisplayMode()

◆ arrayOfPrimitives()

◆ ArrowColor()

◆ ClearSelected()

◆ Component()

◆ Compute()

◆ computePresentation()

◆ ComputeSelection()

◆ createSensitiveEntity()

◆ DatumDisplayMode()

◆ DatumPartColor()

◆ DumpJson()

◆ HasArrowColor()

◆ HasOwnSize()

◆ HasTextColor()

◆ HilightOwnerWithColor()

◆ HilightSelected()

◆ Label()

◆ SelectionPriority()

◆ SetArrowColor() [1/2]

◆ SetArrowColor() [2/2]

◆ SetAxisColor()

◆ SetColor()

◆ SetComponent()

◆ SetDatumDisplayMode()

◆ SetDatumPartColor()

◆ SetDrawArrows()

◆ SetLabel()

◆ SetOriginColor()

◆ setOwnDatumAspect()

◆ SetSelectionPriority()

◆ SetSize()

◆ SetTextColor() [1/2]

◆ SetTextColor() [2/2]

◆ SetXAxisColor()

◆ SetYAxisColor()

◆ Signature()

◆ Size()

◆ TextColor()

◆ ToDrawArrows()

◆ Type()

◆ UnsetColor()

◆ UnsetSize()

◆ updatePrimitives()

Field Documentation

◆ myComponent

◆ myHasOwnArrowColor

◆ myHasOwnSize

◆ myHasOwnTextColor

◆ myHiddenLineAspect

◆ myLabels

◆ myPartToGroup

◆ myPrimitives

◆ mySelectedParts

◆ mySelectionPriority

◆ myTrihDispMode