Open CASCADE Technology Reference Manual 8.0.0
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Protected Member Functions
AIS_ViewCube Class Reference

Interactive object for displaying the view manipulation cube. More...

#include <AIS_ViewCube.hxx>

Inheritance diagram for AIS_ViewCube:
Inheritance graph
[legend]

Public Member Functions

 AIS_ViewCube ()
 Empty constructor.
 
const occ::handle< AIS_AnimationCamera > & ViewAnimation () const
 Return view animation.
 
void SetViewAnimation (const occ::handle< AIS_AnimationCamera > &theAnimation)
 Set view animation.
 
bool ToAutoStartAnimation () const
 Return TRUE if automatic camera transformation on selection (highlighting) is enabled; TRUE by default.
 
void SetAutoStartAnimation (bool theToEnable)
 Enable/disable automatic camera transformation on selection (highlighting). The automatic logic can be disabled if application wants performing action manually basing on picking results (AIS_ViewCubeOwner).
 
bool IsFixedAnimationLoop () const
 Return TRUE if camera animation should be done in uninterruptible loop; TRUE by default.
 
void SetFixedAnimationLoop (bool theToEnable)
 Set if camera animation should be done in uninterruptible loop.
 
void ResetStyles ()
 Reset all size and style parameters to default.
 
Geometry management API
Returns
size (width and height) of View cube sides; 100 by default.
double Size () const
 Sets size (width and height) of View cube sides.
 
void SetSize (double theValue, bool theToAdaptAnother=true)
 Sets size (width and height) of View cube sides.
 
double BoxFacetExtension () const
 Return box facet extension to edge/corner facet split; 10 by default.
 
void SetBoxFacetExtension (double theValue)
 Set new value of box facet extension.
 
double AxesPadding () const
 Return padding between axes and 3D part (box); 10 by default.
 
void SetAxesPadding (double theValue)
 Set new value of padding between axes and 3D part (box).
 
double BoxEdgeGap () const
 Return gap between box edges and box sides; 0 by default.
 
void SetBoxEdgeGap (double theValue)
 Set new value of box edges gap.
 
double BoxEdgeMinSize () const
 Return minimal size of box edge; 2 by default.
 
void SetBoxEdgeMinSize (double theValue)
 Set new value of box edge minimal size.
 
double BoxCornerMinSize () const
 Return minimal size of box corner; 2 by default.
 
void SetBoxCornerMinSize (double theValue)
 Set new value of box corner minimal size.
 
double RoundRadius () const
 Return relative radius of side corners (round rectangle); 0.0 by default. The value in within [0, 0.5] range meaning absolute radius = RoundRadius() / Size().
 
void SetRoundRadius (const double theValue)
 Set relative radius of View Cube sides corners (round rectangle). The value should be within [0, 0.5] range.
 
double AxesRadius () const
 Returns radius of axes of the trihedron; 1.0 by default.
 
void SetAxesRadius (const double theRadius)
 Sets radius of axes of the trihedron.
 
double AxesConeRadius () const
 Returns radius of cone of axes of the trihedron; 3.0 by default.
 
void SetAxesConeRadius (double theRadius)
 Sets radius of cone of axes of the trihedron.
 
double AxesSphereRadius () const
 Returns radius of sphere (central point) of the trihedron; 4.0 by default.
 
void SetAxesSphereRadius (double theRadius)
 Sets radius of sphere (central point) of the trihedron.
 
bool ToDrawAxes () const
 
void SetDrawAxes (bool theValue)
 Enable/disable drawing of trihedron.
 
bool ToDrawEdges () const
 
void SetDrawEdges (bool theValue)
 Enable/disable drawing of edges of View Cube.
 
bool ToDrawVertices () const
 Return TRUE if vertices (vertex) of View Cube is drawn; TRUE by default.
 
void SetDrawVertices (bool theValue)
 Enable/disable drawing of vertices (corners) of View Cube.
 
bool IsYup () const
 Return TRUE if application expects Y-up viewer orientation instead of Z-up; FALSE by default.
 
void SetYup (bool theIsYup, bool theToUpdateLabels=true)
 Set if application expects Y-up viewer orientation instead of Z-up.
 
Style management API

Return shading style of box sides.

const occ::handle< Prs3d_ShadingAspect > & BoxSideStyle () const
 Return shading style of box edges.
 
const occ::handle< Prs3d_ShadingAspect > & BoxEdgeStyle () const
 Return shading style of box edges.
 
const occ::handle< Prs3d_ShadingAspect > & BoxCornerStyle () const
 Return shading style of box corners.
 
const Quantity_ColorBoxColor () const
 Return value of front color for the 3D part of object.
 
void SetBoxColor (const Quantity_Color &theColor)
 Set new value of front color for the 3D part of object.
 
double BoxTransparency () const
 Return transparency for 3D part of object.
 
void SetBoxTransparency (double theValue)
 Set new value of transparency for 3D part of object.
 
const Quantity_ColorInnerColor () const
 Return color of sides back material.
 
void SetInnerColor (const Quantity_Color &theColor)
 Set color of sides back material. Alias for:
 
TCollection_AsciiString BoxSideLabel (V3d_TypeOfOrientation theSide) const
 Return box side label or empty string if undefined. Default labels: FRONT, BACK, LEFT, RIGHT, TOP, BOTTOM.
 
void SetBoxSideLabel (const V3d_TypeOfOrientation theSide, const TCollection_AsciiString &theLabel)
 Set box side label.
 
const Quantity_ColorTextColor () const
 Return text color of labels of box sides; BLACK by default.
 
void SetTextColor (const Quantity_Color &theColor)
 Set color of text labels on box sides. Alias for:
 
const TCollection_AsciiStringFont () const
 Return font name that is used for displaying of sides and axes text. Alias for:
 
void SetFont (const TCollection_AsciiString &theFont)
 Set font name that is used for displaying of sides and axes text. Alias for:
 
double FontHeight () const
 Return height of font.
 
void SetFontHeight (double theValue)
 Change font height. Alias for:
 
TCollection_AsciiString AxisLabel (Prs3d_DatumParts theAxis) const
 Return axes labels or empty string if undefined. Default labels: X, Y, Z.
 
void SetAxesLabels (const TCollection_AsciiString &theX, const TCollection_AsciiString &theY, const TCollection_AsciiString &theZ)
 Set axes labels.
 
void SetColor (const Quantity_Color &theColor) override
 Set new value of color for the whole object.
 
void UnsetColor () override
 Reset color for the whole object.
 
void SetTransparency (const double theValue) override
 Set new value of transparency for the whole object.
 
void UnsetTransparency () override
 Reset transparency for the whole object.
 
void SetMaterial (const Graphic3d_MaterialAspect &theMat) override
 Sets the material for the interactive object.
 
void UnsetMaterial () override
 Sets the material for the interactive object.
 
Presentation computation

Return TRUE for supported display mode.

bool AcceptDisplayMode (const int theMode) const override
 Global selection has no meaning for this class.
 
occ::handle< SelectMgr_EntityOwnerGlobalSelOwner () const override
 Global selection has no meaning for this class.
 
void Compute (const occ::handle< PrsMgr_PresentationManager > &thePrsMgr, const occ::handle< Prs3d_Presentation > &thePrs, const int theMode=0) override
 Compute 3D part of View Cube.
 
void ComputeSelection (const occ::handle< SelectMgr_Selection > &theSelection, const int theMode) override
 Redefine computing of sensitive entities for View Cube.
 
bool IsAutoHilight () const override
 Disables auto highlighting to use HilightSelected() and HilightOwnerWithColor() overridden methods.
 
void ClearSelected () override
 Method which clear all selected owners belonging to this selectable object.
 
void HilightOwnerWithColor (const occ::handle< PrsMgr_PresentationManager > &thePM, const occ::handle< Prs3d_Drawer > &theStyle, const occ::handle< SelectMgr_EntityOwner > &theOwner) override
 Method which highlights input owner belonging to this selectable object.
 
void HilightSelected (const occ::handle< PrsMgr_PresentationManager > &thePM, const NCollection_Sequence< occ::handle< SelectMgr_EntityOwner > > &theSeq) override
 Method which draws selected owners.
 
void UnsetAttributes () override
 Set default parameters for visual attributes.
 
void UnsetHilightAttributes () override
 Set default parameters for dynamic highlighting attributes, reset highlight attributes.
 
- Public Member Functions inherited from AIS_InteractiveObject
virtual AIS_KindOfInteractive Type () const
 Returns the kind of Interactive Object; AIS_KindOfInteractive_None by default.
 
virtual int Signature () const
 Specifies additional characteristics of Interactive Object of Type(); -1 by default. Among the datums, this signature is attributed to the shape. The remaining datums have the following default signatures:
 
void Redisplay (const bool AllModes=false)
 Updates the active presentation; if <AllModes> = 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.
 
bool HasInteractiveContext () const
 Indicates whether the Interactive Object has a pointer to an interactive context.
 
AIS_InteractiveContextInteractiveContext () const
 Returns the context pointer to the interactive context.
 
virtual void SetContext (const occ::handle< AIS_InteractiveContext > &aCtx)
 Sets the interactive context aCtx and provides a link to the default drawing tool or "Drawer" if there is none.
 
bool 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 occ::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 occ::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 bool ProcessDragging (const occ::handle< AIS_InteractiveContext > &theCtx, const occ::handle< V3d_View > &theView, const occ::handle< SelectMgr_EntityOwner > &theOwner, const NCollection_Vec2< int > &theDragFrom, const NCollection_Vec2< int > &theDragTo, const AIS_DragAction theAction)
 Drag object in the viewer.
 
occ::handle< AIS_InteractiveContextGetContext () const
 Returns the context pointer to the interactive context.
 
bool HasPresentation () const
 Returns TRUE when this object has a presentation in the current DisplayMode()
 
occ::handle< Prs3d_PresentationPresentation () const
 Returns the current presentation of this object according to the current DisplayMode()
 
void SetAspect (const occ::handle< Prs3d_BasicAspect > &anAspect)
 Sets the graphic basic aspect to the current presentation.
 
void DumpJson (Standard_OStream &theOStream, int theDepth=-1) const override
 Dumps the content of me into the stream.
 
- Public Member Functions inherited from SelectMgr_SelectableObject
 ~SelectMgr_SelectableObject () override
 Clears all selections of the object.
 
virtual bool 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 int 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 occ::handle< SelectMgr_Selection > &aSelection, const int aMode)
 Adds the selection aSelection with the selection mode index aMode to this framework.
 
void ClearSelections (const bool update=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 occ::handle< SelectMgr_Selection > & Selection (const int theMode) const
 Returns the selection having specified selection mode or NULL.
 
bool HasSelection (const int theMode) const
 Returns true if a selection corresponding to the selection mode theMode was computed for this object.
 
const NCollection_Sequence< occ::handle< SelectMgr_Selection > > & Selections () const
 Return the sequence of selections.
 
void ResetTransformation () override
 resets local transformation to identity.
 
void UpdateTransformation () override
 Recomputes the location of the selection aSelection.
 
virtual void UpdateTransformations (const occ::handle< SelectMgr_Selection > &aSelection)
 Updates locations in all sensitive entities from <aSelection> and in corresponding entity owners.
 
virtual void ClearDynamicHighlight (const occ::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 void SetAutoHilight (const bool theAutoHilight)
 Set AutoHilight property to true or false.
 
occ::handle< Prs3d_PresentationGetHilightPresentation (const occ::handle< PrsMgr_PresentationManager > &thePrsMgr)
 Creates or returns existing presentation for highlighting detected object.
 
occ::handle< Prs3d_PresentationGetSelectPresentation (const occ::handle< PrsMgr_PresentationManager > &thePrsMgr)
 Creates or returns existing presentation for highlighting selected object.
 
virtual void ErasePresentations (bool theToRemove)
 Removes presentations returned by GetHilightPresentation() and GetSelectPresentation().
 
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 int 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 occ::handle< SelectMgr_EntityOwner > &theOwner, const int theMode=-1)
 Sets common entity owner for assembly sensitive object entities.
 
Bnd_Box BndBoxOfSelected (const occ::handle< NCollection_Shared< NCollection_IndexedMap< occ::handle< SelectMgr_EntityOwner > > > > &theOwners)
 Returns a bounding box of sensitive entities with the owners given if they are a part of activated selection.
 
int GlobalSelectionMode () const
 Returns the mode for selection of object as a whole; 0 by default.
 
virtual const occ::handle< SelectMgr_EntityOwner > & GetAssemblyOwner () const
 Returns common entity owner if the object is an assembly.
 
void DumpJson (Standard_OStream &theOStream, int theDepth=-1) const override
 Dumps the content of me into the stream.
 
- Public Member Functions inherited from PrsMgr_PresentableObject
NCollection_Sequence< occ::handle< PrsMgr_Presentation > > & Presentations ()
 Return presentations.
 
Graphic3d_ZLayerId ZLayer () const
 Get ID of Z layer for main presentation.
 
bool 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 bool 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 occ::handle< Graphic3d_ViewAffinity > & ViewAffinity () const
 Return view affinity mask.
 
bool HasDisplayMode () const
 Returns true if the Interactive Object has display mode setting overriding global setting (within Interactive Context).
 
int 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 int 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.
 
bool HasHilightMode () const
 Returns true if the Interactive Object is in highlight mode.
 
int HilightMode () const
 Returns highlight display mode. This is obsolete method for backward compatibility - use HilightAttributes() and DynamicHilightAttributes() instead.
 
void SetHilightMode (const int theMode)
 Sets highlight display mode. This is obsolete method for backward compatibility - use HilightAttributes() and DynamicHilightAttributes() instead.
 
void UnsetHilightMode ()
 Unsets highlight display mode.
 
virtual int DefaultDisplayMode () const
 Returns the default display mode.
 
bool ToBeUpdated (bool theToIncludeHidden=false) const
 Returns TRUE if any active presentation has invalidation flag.
 
void SetToUpdate (int theMode)
 Flags presentation to be updated; UpdatePresentations() will recompute these presentations.
 
void SetToUpdate ()
 flags all the Presentations to be Updated.
 
bool 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 bool theFlag=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 occ::handle< Prs3d_Drawer > & Attributes () const
 Initializes the drawing tool theDrawer.
 
virtual void SetAttributes (const occ::handle< Prs3d_Drawer > &theDrawer)
 Initializes the drawing tool theDrawer.
 
const occ::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 occ::handle< Prs3d_Drawer > &theDrawer)
 Initializes the hilight drawing tool theDrawer.
 
const occ::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 occ::handle< Prs3d_Drawer > &theDrawer)
 Initializes the dynamic hilight drawing tool.
 
void SynchronizeAspects ()
 Synchronize presentation aspects after their modification.
 
const occ::handle< Graphic3d_TransformPers > & TransformPersistence () const
 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.
 
virtual void SetTransformPersistence (const occ::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 occ::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 occ::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.
 
bool HasTransformation () const
 Returns true if object has a transformation that is different from the identity.
 
const occ::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_TrsfLocalTransformation () 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_TrsfTransformation () 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_GTrsfInversedTransformation () const
 Return inversed transformation.
 
const occ::handle< TopLoc_Datum3D > & CombinedParentTransformation () const
 Return combined parent transformation.
 
virtual void RecomputeTransformation (const occ::handle< Graphic3d_Camera > &theProjector)
 Calculates object presentation for specific camera position. Each of the views in the viewer and every modification such as rotation, for example, entails recalculation.
 
const occ::handle< Graphic3d_SequenceOfHClipPlane > & ClipPlanes () const
 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 SetClipPlanes (const occ::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 occ::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 occ::handle< Graphic3d_ClipPlane > &thePlane)
 Removes previously added clip plane.
 
PrsMgr_PresentableObjectParent () const
 Returns children of the current object.
 
const NCollection_List< occ::handle< PrsMgr_PresentableObject > > & Children () const
 Returns children of the current object.
 
virtual void AddChild (const occ::handle< PrsMgr_PresentableObject > &theObject)
 Makes theObject child of current object in scene hierarchy.
 
void AddChildWithCurrentTransformation (const occ::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 occ::handle< PrsMgr_PresentableObject > &theObject)
 Removes theObject from children of current object in scene hierarchy.
 
void RemoveChildWithRestoreTransformation (const occ::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.
 
bool 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 bool theIsEnabled)
 Returns the current facing model which is in effect.
 
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.
 
bool 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.
 
bool HasWidth () const
 Returns true if the Interactive Object has width.
 
double Width () const
 Returns the width setting of the Interactive Object.
 
virtual void SetWidth (const double 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.
 
bool 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.
 
bool IsTransparent () const
 Returns true if there is a transparency setting.
 
virtual double 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 bool HasPolygonOffsets () const
 Returns true if <myDrawer> has non-null shading aspect.
 
virtual void PolygonOffsets (int &aMode, float &aFactor, float &aUnits) const
 Retrieves current polygon offsets settings from <myDrawer>.
 
virtual void SetPolygonOffsets (const int aMode, const float aFactor=1.0, const float aUnits=0.0)
 Sets up polygon offsets for this object.
 
void ToBeUpdated (NCollection_List< int > &ListOfMode) const
 pointer to the parent object
 
bool 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 bool 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_Transientoperator= (const Standard_Transient &)
 Assignment operator, needed to avoid copying reference counter.
 
virtual ~Standard_Transient ()=default
 Destructor must be virtual.
 
virtual const opencascade::handle< Standard_Type > & DynamicType () const
 Returns a type descriptor about this object.
 
bool IsInstance (const opencascade::handle< Standard_Type > &theType) const
 Returns a true value if this is an instance of Type.
 
bool IsInstance (const char *const theTypeName) const
 Returns a true value if this is an instance of TypeName.
 
bool 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.
 
bool IsKind (const char *const 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_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.
 
int GetRefCount () const noexcept
 Get the reference counter of this object.
 
void IncrementRefCounter () noexcept
 Increments the reference counter of this object. Uses relaxed memory ordering since incrementing only requires atomicity, not synchronization with other memory operations.
 
int DecrementRefCounter () noexcept
 Decrements the reference counter of this object; returns the decremented value. Uses release ordering for the decrement to ensure all writes to the object are visible before the count reaches zero. An acquire fence is added only when the count reaches zero, ensuring proper synchronization before deletion. This is more efficient than using acq_rel for every decrement.
 
virtual void Delete () const
 Memory deallocator for transient classes.
 

Static Public Member Functions

static bool IsBoxSide (V3d_TypeOfOrientation theOrient)
 Return TRUE if specified orientation belongs to box side.
 
static bool IsBoxEdge (V3d_TypeOfOrientation theOrient)
 Return TRUE if specified orientation belongs to box edge.
 
static bool IsBoxCorner (V3d_TypeOfOrientation theOrient)
 Return TRUE if specified orientation belongs to box corner (vertex).
 
- Static Public Member Functions inherited from Standard_Transient
static constexpr const charget_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.
 

Protected Member Functions

void setDefaultAttributes ()
 Set default visual attributes.
 
void setDefaultHighlightAttributes ()
 Set default dynamic highlight properties.
 
protected virtual API

Method that is called after one step of transformation.

virtual void onAfterAnimation ()
 Method that is called after transformation finish.
 
virtual void onAnimationFinished ()
 Method that is called after transformation finish.
 
- 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 int theMode)
 Override global selection mode.
 
void UpdateClipping () override
 Update clipping planes state.
 
virtual void updateSelection (const int 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
called instead void Update (bool theToIncludeHidden=false)
 Recomputes all presentations of the object.
 
This method is deprecated SetToUpdate ()+UpdatePresentations() should be called instead") 1 void Update(int theMode
 Recomputes the presentation in the given mode.
 
 PrsMgr_PresentableObject (const PrsMgr_TypeOfPresentation3d aTypeOfPresentation3d=PrsMgr_TOP_AllView)
 Destructor.
 
 ~PrsMgr_PresentableObject () override
 Destructor.
 
virtual void Fill (const occ::handle< PrsMgr_PresentationManager > &thePrsMgr, const occ::handle< PrsMgr_Presentation > &thePrs, const int 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 occ::handle< Graphic3d_Camera > &theProjector, const occ::handle< TopLoc_Datum3D > &theTrsf, const occ::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.
 
bool UpdatePresentations (bool theToIncludeHidden=false)
 Recomputes invalidated presentations of the object.
 
virtual void SetCombinedParentTransform (const occ::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 occ::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 NCollection_DataMap< occ::handle< Graphic3d_Aspects >, occ::handle< Graphic3d_Aspects > > &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

Animation options
occ::handle< AIS_AnimationCameramyViewAnimation
 Camera animation object.
 
occ::handle< Graphic3d_CameramyStartState
 Start state of view camera.
 
occ::handle< Graphic3d_CameramyEndState
 End state of view camera.
 
bool myToAutoStartAnim
 start animation automatically on click
 
bool myIsFixedAnimation
 fixed-loop animation
 
bool myToFitSelected
 fit selected or fit entire scene
 
bool myToResetCameraUp
 always reset camera up direction to default
 
- Protected Attributes inherited from AIS_InteractiveObject
AIS_InteractiveContextmyCTXPtr
 pointer to Interactive Context, where object is currently displayed;
 
occ::handle< Standard_TransientmyOwner
 application-specific owner object
 
- Protected Attributes inherited from SelectMgr_SelectableObject
NCollection_Sequence< occ::handle< SelectMgr_Selection > > myselections
 list of selections
 
occ::handle< Prs3d_PresentationmySelectionPrs
 optional presentation for highlighting selected object
 
occ::handle< Prs3d_PresentationmyHilightPrs
 optional presentation for highlighting detected object
 
int myGlobalSelMode
 global selection mode
 
bool myAutoHilight
 auto-highlighting flag defining
 
- Protected Attributes inherited from PrsMgr_PresentableObject
This method is deprecated bool theToClearOther
 pointer to the parent object
 
PrsMgr_PresentableObjectmyParent
 pointer to the parent object
 
NCollection_Sequence< occ::handle< PrsMgr_Presentation > > myPresentations
 list of presentations
 
occ::handle< Graphic3d_ViewAffinitymyViewAffinity
 view affinity mask
 
occ::handle< Graphic3d_SequenceOfHClipPlanemyClipPlanes
 sequence of object-specific clipping planes
 
occ::handle< Prs3d_DrawermyDrawer
 main presentation attributes
 
occ::handle< Prs3d_DrawermyHilightDrawer
 (optional) custom presentation attributes for highlighting selected object
 
occ::handle< Prs3d_DrawermyDynHilightDrawer
 (optional) custom presentation attributes for highlighting detected object
 
occ::handle< Graphic3d_TransformPersmyTransformPersistence
 transformation persistence
 
occ::handle< TopLoc_Datum3DmyLocalTransformation
 local transformation relative to parent object
 
occ::handle< TopLoc_Datum3DmyTransformation
 absolute transformation of this object (combined parents + local transformations)
 
occ::handle< TopLoc_Datum3DmyCombinedParentTransform
 transformation of parent object (combined for all parents)
 
NCollection_List< occ::handle< PrsMgr_PresentableObject > > 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
 
float myOwnWidth
 custom width value
 
bool hasOwnColor
 own color flag
 
bool hasOwnMaterial
 own material flag
 
bool myInfiniteState
 infinite flag
 
bool myIsMutable
 mutable flag
 
bool myHasOwnPresentations
 flag indicating if object should have own presentations
 
bool myToPropagateVisualState
 flag indicating if visual state (display/erase/color) should be propagated to all children
 

Auxiliary classes to fill presentation with proper primitives

Create triangulation for a box part - for presentation and selection purposes.

Parameters
theTris[in,out] triangulation to fill, or NULL to return size
theNbNodes[in,out] should be incremented by a number of nodes defining this triangulation
theNbTris[in,out] should be incremented by a number of triangles defining this triangulation
[in]theDirpart to define
NCollection_DataMap< V3d_TypeOfOrientation, TCollection_AsciiStringmyBoxSideLabels
 map with box side labels
 
NCollection_DataMap< Prs3d_DatumParts, TCollection_AsciiStringmyAxesLabels
 map with axes labels
 
occ::handle< Prs3d_ShadingAspectmyBoxEdgeAspect
 style for box edges
 
occ::handle< Prs3d_ShadingAspectmyBoxCornerAspect
 style for box corner
 
double mySize
 size of box side, length of one axis
 
double myBoxEdgeMinSize
 minimal size of box edge
 
double myBoxEdgeGap
 gap between box side and box edge
 
double myBoxFacetExtension
 box facet extension
 
double myAxesPadding
 Padding between box and axes.
 
double myAxesRadius
 radius of axes of the trihedron; 1.0 by default
 
double myAxesConeRadius
 radius of cone of axes of the trihedron; 3.0 by default
 
double myAxesSphereRadius
 radius of sphere (central point) of the trihedron; 4.0 by default
 
double myCornerMinSize
 minimal size of box corner
 
double myRoundRadius
 relative round radius within [0; 0.5] range
 
bool myToDisplayAxes
 trihedron visibility
 
bool myToDisplayEdges
 box edges visibility
 
bool myToDisplayVertices
 box corners (vertices) visibility
 
bool myIsYup
 flag indicating that application expects Y-up viewer orientation instead of Z-up
 
virtual void createBoxPartTriangles (const occ::handle< Graphic3d_ArrayOfTriangles > &theTris, int &theNbNodes, int &theNbTris, V3d_TypeOfOrientation theDir) const
 map with box side labels
 
virtual void createBoxSideTriangles (const occ::handle< Graphic3d_ArrayOfTriangles > &theTris, int &theNbNodes, int &theNbTris, V3d_TypeOfOrientation theDir) const
 Create triangulation for a box side.
 
virtual void createBoxEdgeTriangles (const occ::handle< Graphic3d_ArrayOfTriangles > &theTris, int &theNbNodes, int &theNbTris, V3d_TypeOfOrientation theDir) const
 Create triangulation for a box edge.
 
virtual void createBoxCornerTriangles (const occ::handle< Graphic3d_ArrayOfTriangles > &theTris, int &theNbNodes, int &theNbTris, V3d_TypeOfOrientation theDir) const
 Create triangulation for a box corner (vertex).
 
static void createRoundRectangleTriangles (const occ::handle< Graphic3d_ArrayOfTriangles > &theTris, int &theNbNodes, int &theNbTris, const gp_XY &theSize, double theRadius, const gp_Trsf &theTrsf)
 Create triangulation for a rectangle with round corners.
 

animation methods

Return duration of animation in seconds; 0.5 sec by default

double Duration () const
 Set duration of animation.
 
void SetDuration (double theValue)
 Set duration of animation.
 
bool ToResetCameraUp () const
 Return TRUE if new camera Up direction should be always set to default value for a new camera Direction; FALSE by default. When this flag is FALSE, the new camera Up will be set as current Up orthogonalized to the new camera Direction, and will set to default Up on second click.
 
void SetResetCamera (bool theToReset)
 Set if new camera Up direction should be always set to default value for a new camera Direction.
 
bool ToFitSelected () const
 Return TRUE if animation should fit selected objects and FALSE to fit entire scene; TRUE by default.
 
void SetFitSelected (bool theToFitSelected)
 Set if animation should fit selected objects or to fit entire scene.
 
bool HasAnimation () const
 
virtual void StartAnimation (const occ::handle< AIS_ViewCubeOwner > &theOwner)
 Start camera transformation corresponding to the input detected owner.
 
virtual bool UpdateAnimation (const bool theToUpdate)
 Perform one step of current camera transformation. theToUpdate[in] enable/disable update of view.
 
virtual void HandleClick (const occ::handle< AIS_ViewCubeOwner > &theOwner)
 Perform camera transformation corresponding to the input detected owner.
 
bool updateAnimation ()
 Perform internal single step of animation.
 
virtual void viewFitAll (const occ::handle< V3d_View > &theView, const occ::handle< Graphic3d_Camera > &theCamera)
 Fit selected/all into view.
 

Additional Inherited Members

- Public Types inherited from Standard_Transient
typedef void base_type
 Returns a type descriptor about this object.
 
- Static Protected Member Functions inherited from PrsMgr_PresentableObject
static const gp_TrsfgetIdentityTrsf ()
 Return the identity transformation.
 

Detailed Description

Interactive object for displaying the view manipulation cube.

View cube consists of several parts that are responsible for different camera manipulations:

The object is expected to behave like a trihedron in the view corner, therefore its position should be defined using transformation persistence flags:

@ Aspect_TOTP_LEFT_LOWER
at the left lower corner
Definition Aspect_TypeOfTriedronPosition.hxx:28
@ Graphic3d_TMF_TriedronPers
object behaves like trihedron - it is fixed at the corner of view and does not resizing (but rotating...
Definition Graphic3d_TransModeFlags.hxx:26
Transformation Persistence definition.
Definition Graphic3d_TransformPers.hxx:52
STL input iterator that wraps an OCCT More()/Next() iterator.
Definition NCollection_ForwardRange.hxx:142
virtual void SetTransformPersistence(const occ::handle< Graphic3d_TransformPers > &theTrsfPers)
Sets up Transform Persistence defining a special Local Coordinate system where this object should be ...

View Cube parts are sensitive to detection, or dynamic highlighting (but not selection), and every its owner AIS_ViewCubeOwner corresponds to camera transformation.

for (aViewCube->StartAnimation (aDetectedOwner); aViewCube->HasAnimation(); )
{
aViewCube->UpdateAnimation();
... // updating of application window
}

or

aViewCube->HandleClick (aDetectedOwner);

that includes transformation loop. This loop allows external actions like application updating. For this purpose AIS_ViewCube has virtual interface onAfterAnimation(), that is to be redefined on application level.

Constructor & Destructor Documentation

◆ AIS_ViewCube()

AIS_ViewCube::AIS_ViewCube ( )

Empty constructor.

Member Function Documentation

◆ AcceptDisplayMode()

bool AIS_ViewCube::AcceptDisplayMode ( const int theMode) const
inlineoverridevirtual

Global selection has no meaning for this class.

Reimplemented from PrsMgr_PresentableObject.

◆ AxesConeRadius()

double AIS_ViewCube::AxesConeRadius ( ) const
inline

Returns radius of cone of axes of the trihedron; 3.0 by default.

◆ AxesPadding()

double AIS_ViewCube::AxesPadding ( ) const
inline

Return padding between axes and 3D part (box); 10 by default.

◆ AxesRadius()

double AIS_ViewCube::AxesRadius ( ) const
inline

Returns radius of axes of the trihedron; 1.0 by default.

◆ AxesSphereRadius()

double AIS_ViewCube::AxesSphereRadius ( ) const
inline

Returns radius of sphere (central point) of the trihedron; 4.0 by default.

◆ AxisLabel()

TCollection_AsciiString AIS_ViewCube::AxisLabel ( Prs3d_DatumParts theAxis) const
inline

Return axes labels or empty string if undefined. Default labels: X, Y, Z.

◆ BoxColor()

const Quantity_Color & AIS_ViewCube::BoxColor ( ) const
inline

Return value of front color for the 3D part of object.

◆ BoxCornerMinSize()

double AIS_ViewCube::BoxCornerMinSize ( ) const
inline

Return minimal size of box corner; 2 by default.

◆ BoxCornerStyle()

const occ::handle< Prs3d_ShadingAspect > & AIS_ViewCube::BoxCornerStyle ( ) const
inline

Return shading style of box corners.

◆ BoxEdgeGap()

double AIS_ViewCube::BoxEdgeGap ( ) const
inline

Return gap between box edges and box sides; 0 by default.

◆ BoxEdgeMinSize()

double AIS_ViewCube::BoxEdgeMinSize ( ) const
inline

Return minimal size of box edge; 2 by default.

◆ BoxEdgeStyle()

const occ::handle< Prs3d_ShadingAspect > & AIS_ViewCube::BoxEdgeStyle ( ) const
inline

Return shading style of box edges.

◆ BoxFacetExtension()

double AIS_ViewCube::BoxFacetExtension ( ) const
inline

Return box facet extension to edge/corner facet split; 10 by default.

◆ BoxSideLabel()

TCollection_AsciiString AIS_ViewCube::BoxSideLabel ( V3d_TypeOfOrientation theSide) const
inline

Return box side label or empty string if undefined. Default labels: FRONT, BACK, LEFT, RIGHT, TOP, BOTTOM.

◆ BoxSideStyle()

const occ::handle< Prs3d_ShadingAspect > & AIS_ViewCube::BoxSideStyle ( ) const
inline

Return shading style of box edges.

◆ BoxTransparency()

double AIS_ViewCube::BoxTransparency ( ) const
inline

Return transparency for 3D part of object.

◆ ClearSelected()

void AIS_ViewCube::ClearSelected ( )
inlineoverridevirtual

Method which clear all selected owners belonging to this selectable object.

Warning
this object does not support selection.

Reimplemented from SelectMgr_SelectableObject.

◆ Compute()

void AIS_ViewCube::Compute ( const occ::handle< PrsMgr_PresentationManager > & thePrsMgr,
const occ::handle< Prs3d_Presentation > & thePrs,
const int theMode = 0 )
overridevirtual

Compute 3D part of View Cube.

Parameters
[in]thePrsMgrpresentation manager.
[in]thePrsinput presentation that is to be filled with flat presentation primitives.
[in]theModedisplay mode.
Warning
this object accept only 0 display mode.

Implements PrsMgr_PresentableObject.

◆ ComputeSelection()

void AIS_ViewCube::ComputeSelection ( const occ::handle< SelectMgr_Selection > & theSelection,
const int theMode )
overridevirtual

Redefine computing of sensitive entities for View Cube.

Parameters
[in]theSelectioninput selection object that is to be filled with sensitive entities.
[in]theModeselection mode.
Warning
object accepts only 0 selection mode.

Implements SelectMgr_SelectableObject.

◆ createBoxCornerTriangles()

virtual void AIS_ViewCube::createBoxCornerTriangles ( const occ::handle< Graphic3d_ArrayOfTriangles > & theTris,
int & theNbNodes,
int & theNbTris,
V3d_TypeOfOrientation theDir ) const
protectedvirtual

Create triangulation for a box corner (vertex).

Parameters
theTris[in,out] triangulation to fill, or NULL to return size
theNbNodes[in,out] should be incremented by a number of nodes defining this triangulation
theNbTris[in,out] should be incremented by a number of triangles defining this triangulation
[in]theDirpart to define

◆ createBoxEdgeTriangles()

virtual void AIS_ViewCube::createBoxEdgeTriangles ( const occ::handle< Graphic3d_ArrayOfTriangles > & theTris,
int & theNbNodes,
int & theNbTris,
V3d_TypeOfOrientation theDir ) const
protectedvirtual

Create triangulation for a box edge.

Parameters
theTris[in,out] triangulation to fill, or NULL to return size
theNbNodes[in,out] should be incremented by a number of nodes defining this triangulation
theNbTris[in,out] should be incremented by a number of triangles defining this triangulation
[in]theDirpart to define

◆ createBoxPartTriangles()

virtual void AIS_ViewCube::createBoxPartTriangles ( const occ::handle< Graphic3d_ArrayOfTriangles > & theTris,
int & theNbNodes,
int & theNbTris,
V3d_TypeOfOrientation theDir ) const
protectedvirtual

map with box side labels

◆ createBoxSideTriangles()

virtual void AIS_ViewCube::createBoxSideTriangles ( const occ::handle< Graphic3d_ArrayOfTriangles > & theTris,
int & theNbNodes,
int & theNbTris,
V3d_TypeOfOrientation theDir ) const
protectedvirtual

Create triangulation for a box side.

Parameters
theTris[in,out] triangulation to fill, or NULL to return size
theNbNodes[in,out] should be incremented by a number of nodes defining this triangulation
theNbTris[in,out] should be incremented by a number of triangles defining this triangulation
[in]theDirpart to define

◆ createRoundRectangleTriangles()

static void AIS_ViewCube::createRoundRectangleTriangles ( const occ::handle< Graphic3d_ArrayOfTriangles > & theTris,
int & theNbNodes,
int & theNbTris,
const gp_XY & theSize,
double theRadius,
const gp_Trsf & theTrsf )
staticprotected

Create triangulation for a rectangle with round corners.

Parameters
theTris[in,out] triangulation to fill, or NULL to return size
theNbNodes[in,out] should be incremented by a number of nodes defining this triangulation
theNbTris[in,out] should be incremented by a number of triangles defining this triangulation
[in]theSizerectangle dimensions
[in]theRadiusradius at corners
[in]theTrsftransformation

◆ Duration()

double AIS_ViewCube::Duration ( ) const

Set duration of animation.

Parameters
[in]theValueinput value of duration in seconds

◆ Font()

const TCollection_AsciiString & AIS_ViewCube::Font ( ) const
inline

Return font name that is used for displaying of sides and axes text. Alias for:

Attributes()->TextAspect()->Aspect()->SetFont()
const occ::handle< Prs3d_Drawer > & Attributes() const
Initializes the drawing tool theDrawer.
Definition PrsMgr_PresentableObject.hxx:193

◆ FontHeight()

double AIS_ViewCube::FontHeight ( ) const
inline

Return height of font.

◆ GlobalSelOwner()

occ::handle< SelectMgr_EntityOwner > AIS_ViewCube::GlobalSelOwner ( ) const
inlineoverridevirtual

Global selection has no meaning for this class.

Reimplemented from SelectMgr_SelectableObject.

◆ HandleClick()

virtual void AIS_ViewCube::HandleClick ( const occ::handle< AIS_ViewCubeOwner > & theOwner)
virtual

Perform camera transformation corresponding to the input detected owner.

◆ HasAnimation()

bool AIS_ViewCube::HasAnimation ( ) const
Returns
TRUE if View Cube has unfinished animation of view camera.

◆ HilightOwnerWithColor()

void AIS_ViewCube::HilightOwnerWithColor ( const occ::handle< PrsMgr_PresentationManager > & thePM,
const occ::handle< Prs3d_Drawer > & theStyle,
const occ::handle< SelectMgr_EntityOwner > & theOwner )
overridevirtual

Method which highlights input owner belonging to this selectable object.

Parameters
[in]thePMpresentation manager
[in]theStylestyle for dynamic highlighting.
[in]theOwnerinput entity owner.

Reimplemented from SelectMgr_SelectableObject.

◆ HilightSelected()

void AIS_ViewCube::HilightSelected ( const occ::handle< PrsMgr_PresentationManager > & thePM,
const NCollection_Sequence< occ::handle< SelectMgr_EntityOwner > > & theSeq )
overridevirtual

Method which draws selected owners.

Reimplemented from SelectMgr_SelectableObject.

◆ InnerColor()

const Quantity_Color & AIS_ViewCube::InnerColor ( ) const
inline

Return color of sides back material.

◆ IsAutoHilight()

bool AIS_ViewCube::IsAutoHilight ( ) const
inlineoverridevirtual

Disables auto highlighting to use HilightSelected() and HilightOwnerWithColor() overridden methods.

Reimplemented from SelectMgr_SelectableObject.

◆ IsBoxCorner()

static bool AIS_ViewCube::IsBoxCorner ( V3d_TypeOfOrientation theOrient)
static

Return TRUE if specified orientation belongs to box corner (vertex).

◆ IsBoxEdge()

static bool AIS_ViewCube::IsBoxEdge ( V3d_TypeOfOrientation theOrient)
static

Return TRUE if specified orientation belongs to box edge.

◆ IsBoxSide()

static bool AIS_ViewCube::IsBoxSide ( V3d_TypeOfOrientation theOrient)
static

Return TRUE if specified orientation belongs to box side.

◆ IsFixedAnimationLoop()

bool AIS_ViewCube::IsFixedAnimationLoop ( ) const
inline

Return TRUE if camera animation should be done in uninterruptible loop; TRUE by default.

◆ IsYup()

bool AIS_ViewCube::IsYup ( ) const
inline

Return TRUE if application expects Y-up viewer orientation instead of Z-up; FALSE by default.

◆ onAfterAnimation()

virtual void AIS_ViewCube::onAfterAnimation ( )
inlineprotectedvirtual

Method that is called after transformation finish.

◆ onAnimationFinished()

virtual void AIS_ViewCube::onAnimationFinished ( )
inlineprotectedvirtual

Method that is called after transformation finish.

◆ ResetStyles()

void AIS_ViewCube::ResetStyles ( )

Reset all size and style parameters to default.

Warning
It doesn't reset position of View Cube

◆ RoundRadius()

double AIS_ViewCube::RoundRadius ( ) const
inline

Return relative radius of side corners (round rectangle); 0.0 by default. The value in within [0, 0.5] range meaning absolute radius = RoundRadius() / Size().

◆ SetAutoStartAnimation()

void AIS_ViewCube::SetAutoStartAnimation ( bool theToEnable)
inline

Enable/disable automatic camera transformation on selection (highlighting). The automatic logic can be disabled if application wants performing action manually basing on picking results (AIS_ViewCubeOwner).

◆ SetAxesConeRadius()

void AIS_ViewCube::SetAxesConeRadius ( double theRadius)
inline

Sets radius of cone of axes of the trihedron.

◆ SetAxesLabels()

void AIS_ViewCube::SetAxesLabels ( const TCollection_AsciiString & theX,
const TCollection_AsciiString & theY,
const TCollection_AsciiString & theZ )
inline

Set axes labels.

◆ SetAxesPadding()

void AIS_ViewCube::SetAxesPadding ( double theValue)
inline

Set new value of padding between axes and 3D part (box).

◆ SetAxesRadius()

void AIS_ViewCube::SetAxesRadius ( const double theRadius)
inline

Sets radius of axes of the trihedron.

◆ SetAxesSphereRadius()

void AIS_ViewCube::SetAxesSphereRadius ( double theRadius)
inline

Sets radius of sphere (central point) of the trihedron.

◆ SetBoxColor()

void AIS_ViewCube::SetBoxColor ( const Quantity_Color & theColor)
inline

Set new value of front color for the 3D part of object.

Parameters
[in]theColorinput color value.

◆ SetBoxCornerMinSize()

void AIS_ViewCube::SetBoxCornerMinSize ( double theValue)
inline

Set new value of box corner minimal size.

◆ SetBoxEdgeGap()

void AIS_ViewCube::SetBoxEdgeGap ( double theValue)
inline

Set new value of box edges gap.

◆ SetBoxEdgeMinSize()

void AIS_ViewCube::SetBoxEdgeMinSize ( double theValue)
inline

Set new value of box edge minimal size.

◆ SetBoxFacetExtension()

void AIS_ViewCube::SetBoxFacetExtension ( double theValue)
inline

Set new value of box facet extension.

◆ SetBoxSideLabel()

void AIS_ViewCube::SetBoxSideLabel ( const V3d_TypeOfOrientation theSide,
const TCollection_AsciiString & theLabel )
inline

Set box side label.

◆ SetBoxTransparency()

void AIS_ViewCube::SetBoxTransparency ( double theValue)
inline

Set new value of transparency for 3D part of object.

Parameters
[in]theValueinput transparency value

◆ SetColor()

void AIS_ViewCube::SetColor ( const Quantity_Color & theColor)
inlineoverridevirtual

Set new value of color for the whole object.

Parameters
[in]theColorinput color value.

Reimplemented from PrsMgr_PresentableObject.

◆ setDefaultAttributes()

void AIS_ViewCube::setDefaultAttributes ( )
protected

Set default visual attributes.

◆ setDefaultHighlightAttributes()

void AIS_ViewCube::setDefaultHighlightAttributes ( )
protected

Set default dynamic highlight properties.

◆ SetDrawAxes()

void AIS_ViewCube::SetDrawAxes ( bool theValue)
inline

Enable/disable drawing of trihedron.

◆ SetDrawEdges()

void AIS_ViewCube::SetDrawEdges ( bool theValue)
inline

Enable/disable drawing of edges of View Cube.

◆ SetDrawVertices()

void AIS_ViewCube::SetDrawVertices ( bool theValue)
inline

Enable/disable drawing of vertices (corners) of View Cube.

◆ SetDuration()

void AIS_ViewCube::SetDuration ( double theValue)

Set duration of animation.

Parameters
[in]theValueinput value of duration in seconds

◆ SetFitSelected()

void AIS_ViewCube::SetFitSelected ( bool theToFitSelected)
inline

Set if animation should fit selected objects or to fit entire scene.

◆ SetFixedAnimationLoop()

void AIS_ViewCube::SetFixedAnimationLoop ( bool theToEnable)
inline

Set if camera animation should be done in uninterruptible loop.

◆ SetFont()

void AIS_ViewCube::SetFont ( const TCollection_AsciiString & theFont)
inline

Set font name that is used for displaying of sides and axes text. Alias for:

Attributes()->TextAspect()->SetFont()

◆ SetFontHeight()

void AIS_ViewCube::SetFontHeight ( double theValue)
inline

Change font height. Alias for:

Attributes()->TextAspect()->SetHeight()

◆ SetInnerColor()

void AIS_ViewCube::SetInnerColor ( const Quantity_Color & theColor)
inline

Set color of sides back material. Alias for:

Attributes()->ShadingAspect()->Aspect()->ChangeBackMaterial().SetColor()

◆ SetMaterial()

void AIS_ViewCube::SetMaterial ( const Graphic3d_MaterialAspect & theMat)
inlineoverridevirtual

Sets the material for the interactive object.

Reimplemented from PrsMgr_PresentableObject.

◆ SetResetCamera()

void AIS_ViewCube::SetResetCamera ( bool theToReset)
inline

Set if new camera Up direction should be always set to default value for a new camera Direction.

◆ SetRoundRadius()

void AIS_ViewCube::SetRoundRadius ( const double theValue)

Set relative radius of View Cube sides corners (round rectangle). The value should be within [0, 0.5] range.

◆ SetSize()

void AIS_ViewCube::SetSize ( double theValue,
bool theToAdaptAnother = true )

Sets size (width and height) of View cube sides.

Parameters
theToAdaptAnotherif TRUE, then other parameters will be adapted to specified size

◆ SetTextColor()

void AIS_ViewCube::SetTextColor ( const Quantity_Color & theColor)
inline

Set color of text labels on box sides. Alias for:

Attributes()->TextAspect()->SetColor()

◆ SetTransparency()

void AIS_ViewCube::SetTransparency ( const double theValue)
inlineoverridevirtual

Set new value of transparency for the whole object.

Parameters
[in]theValueinput transparency value.

Reimplemented from PrsMgr_PresentableObject.

◆ SetViewAnimation()

void AIS_ViewCube::SetViewAnimation ( const occ::handle< AIS_AnimationCamera > & theAnimation)
inline

Set view animation.

◆ SetYup()

void AIS_ViewCube::SetYup ( bool theIsYup,
bool theToUpdateLabels = true )

Set if application expects Y-up viewer orientation instead of Z-up.

◆ Size()

double AIS_ViewCube::Size ( ) const
inline

Sets size (width and height) of View cube sides.

Parameters
theToAdaptAnotherif TRUE, then other parameters will be adapted to specified size

◆ StartAnimation()

virtual void AIS_ViewCube::StartAnimation ( const occ::handle< AIS_ViewCubeOwner > & theOwner)
virtual

Start camera transformation corresponding to the input detected owner.

Parameters
[in]theOwnerdetected owner.

◆ TextColor()

const Quantity_Color & AIS_ViewCube::TextColor ( ) const
inline

Return text color of labels of box sides; BLACK by default.

◆ ToAutoStartAnimation()

bool AIS_ViewCube::ToAutoStartAnimation ( ) const
inline

Return TRUE if automatic camera transformation on selection (highlighting) is enabled; TRUE by default.

◆ ToDrawAxes()

bool AIS_ViewCube::ToDrawAxes ( ) const
inline
Returns
TRUE if trihedron is drawn; TRUE by default.

◆ ToDrawEdges()

bool AIS_ViewCube::ToDrawEdges ( ) const
inline
Returns
TRUE if edges of View Cube is drawn; TRUE by default.

◆ ToDrawVertices()

bool AIS_ViewCube::ToDrawVertices ( ) const
inline

Return TRUE if vertices (vertex) of View Cube is drawn; TRUE by default.

◆ ToFitSelected()

bool AIS_ViewCube::ToFitSelected ( ) const
inline

Return TRUE if animation should fit selected objects and FALSE to fit entire scene; TRUE by default.

◆ ToResetCameraUp()

bool AIS_ViewCube::ToResetCameraUp ( ) const
inline

Return TRUE if new camera Up direction should be always set to default value for a new camera Direction; FALSE by default. When this flag is FALSE, the new camera Up will be set as current Up orthogonalized to the new camera Direction, and will set to default Up on second click.

◆ UnsetAttributes()

void AIS_ViewCube::UnsetAttributes ( )
inlineoverridevirtual

Set default parameters for visual attributes.

See also
Attributes()

Reimplemented from PrsMgr_PresentableObject.

◆ UnsetColor()

void AIS_ViewCube::UnsetColor ( )
inlineoverridevirtual

Reset color for the whole object.

Reimplemented from PrsMgr_PresentableObject.

◆ UnsetHilightAttributes()

void AIS_ViewCube::UnsetHilightAttributes ( )
inlineoverridevirtual

Set default parameters for dynamic highlighting attributes, reset highlight attributes.

Reimplemented from PrsMgr_PresentableObject.

◆ UnsetMaterial()

void AIS_ViewCube::UnsetMaterial ( )
inlineoverridevirtual

Sets the material for the interactive object.

Reimplemented from PrsMgr_PresentableObject.

◆ UnsetTransparency()

void AIS_ViewCube::UnsetTransparency ( )
inlineoverridevirtual

Reset transparency for the whole object.

Reimplemented from PrsMgr_PresentableObject.

◆ updateAnimation()

bool AIS_ViewCube::updateAnimation ( )
protected

Perform internal single step of animation.

Returns
FALSE if animation has been finished

◆ UpdateAnimation()

virtual bool AIS_ViewCube::UpdateAnimation ( const bool theToUpdate)
virtual

Perform one step of current camera transformation. theToUpdate[in] enable/disable update of view.

Returns
TRUE if animation is not stopped.

◆ ViewAnimation()

const occ::handle< AIS_AnimationCamera > & AIS_ViewCube::ViewAnimation ( ) const
inline

Return view animation.

◆ viewFitAll()

virtual void AIS_ViewCube::viewFitAll ( const occ::handle< V3d_View > & theView,
const occ::handle< Graphic3d_Camera > & theCamera )
protectedvirtual

Fit selected/all into view.

Parameters
[in]theViewview definition to retrieve scene bounding box
theCamera[in,out] camera definition

Field Documentation

◆ myAxesConeRadius

double AIS_ViewCube::myAxesConeRadius
protected

radius of cone of axes of the trihedron; 3.0 by default

◆ myAxesLabels

NCollection_DataMap<Prs3d_DatumParts, TCollection_AsciiString> AIS_ViewCube::myAxesLabels
protected

map with axes labels

◆ myAxesPadding

double AIS_ViewCube::myAxesPadding
protected

Padding between box and axes.

◆ myAxesRadius

double AIS_ViewCube::myAxesRadius
protected

radius of axes of the trihedron; 1.0 by default

◆ myAxesSphereRadius

double AIS_ViewCube::myAxesSphereRadius
protected

radius of sphere (central point) of the trihedron; 4.0 by default

◆ myBoxCornerAspect

occ::handle<Prs3d_ShadingAspect> AIS_ViewCube::myBoxCornerAspect
protected

style for box corner

◆ myBoxEdgeAspect

occ::handle<Prs3d_ShadingAspect> AIS_ViewCube::myBoxEdgeAspect
protected

style for box edges

◆ myBoxEdgeGap

double AIS_ViewCube::myBoxEdgeGap
protected

gap between box side and box edge

◆ myBoxEdgeMinSize

double AIS_ViewCube::myBoxEdgeMinSize
protected

minimal size of box edge

◆ myBoxFacetExtension

double AIS_ViewCube::myBoxFacetExtension
protected

box facet extension

◆ myBoxSideLabels

NCollection_DataMap<V3d_TypeOfOrientation, TCollection_AsciiString> AIS_ViewCube::myBoxSideLabels
protected

map with box side labels

◆ myCornerMinSize

double AIS_ViewCube::myCornerMinSize
protected

minimal size of box corner

◆ myEndState

occ::handle<Graphic3d_Camera> AIS_ViewCube::myEndState
protected

End state of view camera.

◆ myIsFixedAnimation

bool AIS_ViewCube::myIsFixedAnimation
protected

fixed-loop animation

◆ myIsYup

bool AIS_ViewCube::myIsYup
protected

flag indicating that application expects Y-up viewer orientation instead of Z-up

◆ myRoundRadius

double AIS_ViewCube::myRoundRadius
protected

relative round radius within [0; 0.5] range

◆ mySize

double AIS_ViewCube::mySize
protected

size of box side, length of one axis

◆ myStartState

occ::handle<Graphic3d_Camera> AIS_ViewCube::myStartState
protected

Start state of view camera.

◆ myToAutoStartAnim

bool AIS_ViewCube::myToAutoStartAnim
protected

start animation automatically on click

◆ myToDisplayAxes

bool AIS_ViewCube::myToDisplayAxes
protected

trihedron visibility

◆ myToDisplayEdges

bool AIS_ViewCube::myToDisplayEdges
protected

box edges visibility

◆ myToDisplayVertices

bool AIS_ViewCube::myToDisplayVertices
protected

box corners (vertices) visibility

◆ myToFitSelected

bool AIS_ViewCube::myToFitSelected
protected

fit selected or fit entire scene

◆ myToResetCameraUp

bool AIS_ViewCube::myToResetCameraUp
protected

always reset camera up direction to default

◆ myViewAnimation

occ::handle<AIS_AnimationCamera> AIS_ViewCube::myViewAnimation
protected

Camera animation object.


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