Open CASCADE Technology  7.3.1.dev
Data Structures | Public Member Functions
AIS_Manipulator Class Reference

Interactive object class to manipulate local transformation of another interactive object or a group of objects via mouse. It manages three types of manipulations in 3D space: More...

#include <AIS_Manipulator.hxx>

Inheritance diagram for AIS_Manipulator:
Inheritance graph
[legend]

Data Structures

class  Axis
 The class describes on axis sub-object. It includes sub-objects itself: -rotator -translator -scaler. More...
 
struct  BehaviorOnTransform
 Behavior settings to be applied when performing transformation: More...
 
class  Cube
 
class  Disk
 
struct  OptionsForAttach
 Behavior settings to be applied when performing transformation: More...
 
class  Quadric
 
class  Sector
 
class  Sphere
 

Public Member Functions

 AIS_Manipulator ()
 Constructs a manipulator object with default placement and all parts to be displayed. More...
 
 AIS_Manipulator (const gp_Ax2 &thePosition)
 Constructs a manipulator object with input location and positions of axes and all parts to be displayed. More...
 
void SetPart (const Standard_Integer theAxisIndex, const AIS_ManipulatorMode theMode, const Standard_Boolean theIsEnabled)
 Disable or enable visual parts for translation, rotation or scaling for some axis. By default all parts are enabled (will be displayed). More...
 
void SetPart (const AIS_ManipulatorMode theMode, const Standard_Boolean theIsEnabled)
 Disable or enable visual parts for translation, rotation or scaling for ALL axes. By default all parts are enabled (will be displayed). More...
 
void Attach (const Handle< AIS_InteractiveObject > &theObject, const OptionsForAttach &theOptions=OptionsForAttach())
 Attaches himself to the input interactive object and become displayed in the same context. It is placed in the center of object bounding box, and its size is adjusted to the object bounding box. More...
 
void Attach (const Handle< AIS_ManipulatorObjectSequence > &theObject, const OptionsForAttach &theOptions=OptionsForAttach())
 Attaches himself to the input interactive object group and become displayed in the same context. It become attached to the first object, baut manage manipulation of the whole group. It is placed in the center of object bounding box, and its size is adjusted to the object bounding box. More...
 
void EnableMode (const AIS_ManipulatorMode theMode)
 Enable manipualtion mode. More...
 
void SetModeActivationOnDetection (const Standard_Boolean theToEnable)
 Enables mode activation on detection (highlighting). By default, mode is activated on selection of manipulator part. More...
 
Standard_Boolean IsModeActivationOnDetection () const
 
void StartTransform (const Standard_Integer theX, const Standard_Integer theY, const Handle< V3d_View > &theView)
 Init start (reference) transformation. More...
 
void Transform (const gp_Trsf &aTrsf)
 Apply to the owning objects the input transformation. More...
 
void StopTransform (const Standard_Boolean theToApply=Standard_True)
 Reset start (reference) transformation. More...
 
gp_Trsf Transform (const Standard_Integer theX, const Standard_Integer theY, const Handle< V3d_View > &theView)
 Apply transformation made from mouse moving from start position (save on the first Tranform() call and reset on DeactivateCurrentMode() call.) to the in/out mouse position (theX, theY) More...
 
Standard_Boolean ObjectTransformation (const Standard_Integer theX, const Standard_Integer theY, const Handle< V3d_View > &theView, gp_Trsf &theTrsf)
 Computes transformation of parent object according to the active mode and input motion vector. You can use this method to get object transformation according to current mode or use own algorithm to implement any other tranformation for modes. More...
 
void DeactivateCurrentMode ()
 Make inactive the current selected manipulator part and reset current axis index and current mode. After its call HasActiveMode() returns false. More...
 
void Detach ()
 Detaches himself from the owner object, and removes itself from context. More...
 
Handle< AIS_ManipulatorObjectSequence > Objects () const
 
Handle< AIS_InteractiveObjectObject () const
 
Handle< AIS_InteractiveObjectObject (const Standard_Integer theIndex) const
 
Standard_Boolean IsAttached () const
 
Standard_Boolean HasActiveMode () const
 
Standard_Boolean HasActiveTransformation ()
 
gp_Trsf StartTransformation () const
 
gp_Trsf StartTransformation (Standard_Integer theIndex) const
 
Configuration of graphical transformations
void SetZoomPersistence (const Standard_Boolean theToEnable)
 Enable or disable zoom persistence mode for the manipulator. With this mode turned on the presentation will keep fixed screen size. More...
 
Standard_Boolean ZoomPersistence () const
 Returns state of zoom persistence mode, whether it turned on or off. More...
 
virtual void SetTransformPersistence (const Handle< Graphic3d_TransformPers > &theTrsfPers) override
 Redefines transform persistence management to setup transformation for sub-presentation of axes. More...
 
Setters for parameters
AIS_ManipulatorMode ActiveMode () const
 
const gp_Ax2Position () const
 
void SetPosition (const gp_Ax2 &thePosition)
 Sets position of the manipulator object. More...
 
Standard_ShortReal Size () const
 
void SetSize (const Standard_ShortReal theSideLength)
 Sets size (length of side of the manipulator cubic bounding box. More...
 
void SetGap (const Standard_ShortReal theValue)
 Sets gaps between translator, scaler and rotator sub-presentations. More...
 
void SetTransformBehavior (const BehaviorOnTransform &theSettings)
 Sets behavior settings for transformation action carried on the manipulator, whether it translates, rotates together with the transformed object or not. More...
 
BehaviorOnTransformChangeTransformBehavior ()
 
const BehaviorOnTransformTransformBehavior () const
 
- Public Member Functions inherited from AIS_InteractiveObject
virtual AIS_KindOfInteractive Type () const
 Returns the kind of Interactive Object; AIS_KOI_None by default. More...
 
virtual Standard_Integer 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: More...
 
void Redisplay (const Standard_Boolean AllModes=Standard_False)
 Updates the active presentation; if <AllModes> = Standard_True all the presentations inside are recomputed. IMPORTANT: It is preferable to call Redisplay method of corresponding AIS_InteractiveContext instance for cases when it is accessible. This method just redirects call to myCTXPtr, so this class field must be up to date for proper result. More...
 
Standard_Boolean HasInteractiveContext () const
 Indicates whether the Interactive Object has a pointer to an interactive context. More...
 
AIS_InteractiveContextInteractiveContext () const
 Returns the context pointer to the interactive context. More...
 
virtual void SetContext (const Handle< AIS_InteractiveContext > &aCtx)
 Sets the interactive context aCtx and provides a link to the default drawing tool or "Drawer" if there is none. More...
 
Standard_Boolean HasOwner () const
 Returns true if the object has an owner attributed to it. The owner can be a shape for a set of sub-shapes or a sub-shape for sub-shapes which it is composed of, and takes the form of a transient. More...
 
const Handle< Standard_Transient > & GetOwner () const
 Returns the owner of the Interactive Object. The owner can be a shape for a set of sub-shapes or a sub-shape for sub-shapes which it is composed of, and takes the form of a transient. There are two types of owners: More...
 
void SetOwner (const Handle< Standard_Transient > &theApplicativeEntity)
 Allows you to attribute the owner theApplicativeEntity to an Interactive Object. This can be a shape for a set of sub-shapes or a sub-shape for sub-shapes which it is composed of. The owner takes the form of a transient. More...
 
void ClearOwner ()
 Each Interactive Object has methods which allow us to attribute an Owner to it in the form of a Transient. This method removes the owner from the graphic entity. More...
 
Handle< AIS_InteractiveContextGetContext () const
 Returns the context pointer to the interactive context. More...
 
Standard_Boolean HasPresentation () const
 Returns TRUE when this object has a presentation in the current DisplayMode() More...
 
Handle< Prs3d_PresentationPresentation () const
 Returns the current presentation of this object according to the current DisplayMode() More...
 
void SetAspect (const Handle< Prs3d_BasicAspect > &anAspect)
 Sets the graphic basic aspect to the current presentation. More...
 
- Public Member Functions inherited from SelectMgr_SelectableObject
virtual ~SelectMgr_SelectableObject ()
 Clears all selections of the object. More...
 
virtual Standard_Boolean AcceptShapeDecomposition () const
 Informs the graphic context that the interactive Object may be decomposed into sub-shapes for dynamic selection. The most used Interactive Object is AIS_Shape. More...
 
void RecomputePrimitives ()
 Re-computes the sensitive primitives for all modes. IMPORTANT: Do not use this method to update selection primitives except implementing custom selection manager! This method does not take into account necessary BVH updates, but may invalidate the pointers it refers to. TO UPDATE SELECTION properly from outside classes, use method UpdateSelection. More...
 
void RecomputePrimitives (const Standard_Integer theMode)
 Re-computes the sensitive primitives which correspond to the <theMode>th selection mode. IMPORTANT: Do not use this method to update selection primitives except implementing custom selection manager! selection manager! This method does not take into account necessary BVH updates, but may invalidate the pointers it refers to. TO UPDATE SELECTION properly from outside classes, use method UpdateSelection. More...
 
void AddSelection (const Handle< SelectMgr_Selection > &aSelection, const Standard_Integer aMode)
 Adds the selection aSelection with the selection mode index aMode to this framework. More...
 
void ClearSelections (const Standard_Boolean update=Standard_False)
 Empties all the selections in the SelectableObject <update> parameter defines whether all object's selections should be flagged for further update or not. This improved method can be used to recompute an object's selection (without redisplaying the object completely) when some selection mode is activated not for the first time. More...
 
const Handle< SelectMgr_Selection > & Selection (const Standard_Integer theMode) const
 Returns the selection having specified selection mode or NULL. More...
 
Standard_Boolean HasSelection (const Standard_Integer theMode) const
 Returns true if a selection corresponding to the selection mode theMode was computed for this object. More...
 
const SelectMgr_SequenceOfSelectionSelections () const
 Return the sequence of selections. More...
 
void ResetTransformation () override
 resets local transformation to identity. More...
 
virtual void UpdateTransformation () override
 Recomputes the location of the selection aSelection. More...
 
virtual void UpdateTransformations (const Handle< SelectMgr_Selection > &aSelection)
 Updates locations in all sensitive entities from <aSelection> and in corresponding entity owners. More...
 
virtual void ClearDynamicHighlight (const Handle< PrsMgr_PresentationManager > &theMgr)
 Method that needs to be implemented when the object manages selection and dynamic highlighting on its own. Clears or invalidates dynamic highlight presentation. By default it clears immediate draw of given presentation manager. More...
 
virtual void SetAutoHilight (const Standard_Boolean theAutoHilight)
 Set AutoHilight property to true or false. More...
 
Handle< Prs3d_PresentationGetHilightPresentation (const Handle< PrsMgr_PresentationManager > &thePrsMgr)
 Creates or returns existing presentation for highlighting detected object. More...
 
Handle< Prs3d_PresentationGetSelectPresentation (const Handle< PrsMgr_PresentationManager > &thePrsMgr)
 Creates or returns existing presentation for highlighting selected object. More...
 
virtual void ErasePresentations (Standard_Boolean theToRemove)
 Removes presentations returned by GetHilightPresentation() and GetSelectPresentation(). More...
 
virtual void SetZLayer (const Graphic3d_ZLayerId theLayerId) override
 Set Z layer ID and update all presentations of the selectable object. The layers mechanism allows drawing objects in higher layers in overlay of objects in lower layers. More...
 
void UpdateSelection (const Standard_Integer theMode=-1)
 Sets update status FULL to selections of the object. Must be used as the only method of UpdateSelection from outer classes to prevent BVH structures from being outdated. More...
 
void SetAssemblyOwner (const Handle< SelectMgr_EntityOwner > &theOwner, const Standard_Integer theMode=-1)
 Sets common entity owner for assembly sensitive object entities. More...
 
Bnd_Box BndBoxOfSelected (const Handle< SelectMgr_IndexedMapOfOwner > &theOwners)
 Returns a bounding box of sensitive entities with the owners given if they are a part of activated selection. More...
 
Standard_Integer GlobalSelectionMode () const
 Returns the mode for selection of object as a whole; 0 by default. More...
 
virtual Handle< SelectMgr_EntityOwnerGlobalSelOwner () const
 Returns the owner of mode for selection of object as a whole. More...
 
virtual const Handle< SelectMgr_EntityOwner > & GetAssemblyOwner () const
 Returns common entity owner if the object is an assembly. More...
 
void Init ()
 Begins the iteration scanning for sensitive primitives. More...
 
Standard_Boolean More () const
 Continues the iteration scanning for sensitive primitives. More...
 
void Next ()
 Continues the iteration scanning for sensitive primitives. More...
 
const Handle< SelectMgr_Selection > & CurrentSelection () const
 Returns the current selection in this framework. More...
 
- Public Member Functions inherited from PrsMgr_PresentableObject
PrsMgr_PresentationsPresentations ()
 Return presentations. More...
 
Graphic3d_ZLayerId ZLayer () const
 Get ID of Z layer for main presentation. More...
 
Standard_Boolean IsMutable () const
 Returns true if object has mutable nature (content or location are be changed regularly). Mutable object will be managed in different way than static onces (another optimizations). More...
 
virtual void SetMutable (const Standard_Boolean theIsMutable)
 Sets if the object has mutable nature (content or location will be changed regularly). This method should be called before object displaying to take effect. More...
 
Standard_Boolean HasDisplayMode () const
 Returns true if the Interactive Object has display mode setting overriding global setting (within Interactive Context). More...
 
Standard_Integer DisplayMode () const
 Returns the display mode setting of the Interactive Object. The range of supported display mode indexes should be specified within object definition and filtered by AccepDisplayMode(). More...
 
void SetDisplayMode (const Standard_Integer theMode)
 Sets the display mode for the interactive object. An object can have its own temporary display mode, which is different from that proposed by the interactive context. More...
 
void UnsetDisplayMode ()
 Removes display mode settings from the interactive object. More...
 
Standard_Boolean HasHilightMode () const
 Returns true if the Interactive Object is in highlight mode. More...
 
Standard_Integer HilightMode () const
 Returns highlight display mode. This is obsolete method for backward compatibility - use ::HilightAttributes() and ::DynamicHilightAttributes() instead. More...
 
void SetHilightMode (const Standard_Integer theMode)
 Sets highlight display mode. This is obsolete method for backward compatibility - use ::HilightAttributes() and ::DynamicHilightAttributes() instead. More...
 
void UnsetHilightMode ()
 Unsets highlight display mode. More...
 
virtual Standard_Boolean AcceptDisplayMode (const Standard_Integer theMode) const
 Returns true if the class of objects accepts specified display mode index. The interactive context can have a default mode of representation for the set of Interactive Objects. This mode may not be accepted by a given class of objects. Consequently, this virtual method allowing us to get information about the class in question must be implemented. At least one display mode index should be accepted by this method. Although subclass can leave default implementation, it is highly desired defining exact list of supported modes instead, which is usually an enumeration for one object or objects class sharing similar list of display modes. More...
 
virtual Standard_Integer DefaultDisplayMode () const
 Returns the default display mode. More...
 
Standard_Boolean ToBeUpdated (Standard_Boolean theToIncludeHidden=Standard_False) const
 Returns TRUE if any active presentation has invalidation flag. More...
 
void SetToUpdate (Standard_Integer theMode)
 Flags presentation to be updated; UpdatePresentations() will recompute these presentations. More...
 
void SetToUpdate ()
 flags all the Presentations to be Updated. More...
 
Standard_Boolean IsInfinite () const
 Returns true if the interactive object is infinite; FALSE by default. This flag affects various operations operating on bounding box of graphic presentations of this object. For instance, infinite objects are not taken in account for View FitAll. This does not necessarily means that object is actually infinite, auxiliary objects might be also marked with this flag to achieve desired behavior. More...
 
void SetInfiniteState (const Standard_Boolean theFlag=Standard_True)
 Sets if object should be considered as infinite. More...
 
PrsMgr_TypeOfPresentation3d TypeOfPresentation3d () const
 Returns information on whether the object accepts display in HLR mode or not. More...
 
void SetTypeOfPresentation (const PrsMgr_TypeOfPresentation3d theType)
 Set type of presentation. More...
 
const Handle< Prs3d_Drawer > & Attributes () const
 Returns the attributes settings. More...
 
virtual void SetAttributes (const Handle< Prs3d_Drawer > &theDrawer)
 Initializes the drawing tool theDrawer. More...
 
const Handle< Prs3d_Drawer > & HilightAttributes () const
 Returns the hilight attributes settings. When not NULL, overrides both Prs3d_TypeOfHighlight_LocalSelected and Prs3d_TypeOfHighlight_Selected defined within AIS_InteractiveContext. More...
 
virtual void SetHilightAttributes (const Handle< Prs3d_Drawer > &theDrawer)
 Initializes the hilight drawing tool theDrawer. More...
 
const Handle< Prs3d_Drawer > & DynamicHilightAttributes () const
 Returns the hilight attributes settings. When not NULL, overrides both Prs3d_TypeOfHighlight_LocalDynamic and Prs3d_TypeOfHighlight_Dynamic defined within AIS_InteractiveContext. More...
 
virtual void SetDynamicHilightAttributes (const Handle< Prs3d_Drawer > &theDrawer)
 Initializes the dynamic hilight drawing tool. More...
 
virtual void UnsetHilightAttributes ()
 Clears settings provided by the hilight drawing tool theDrawer. More...
 
void SynchronizeAspects ()
 Synchronize presentation aspects after their modification. More...
 
const Handle< Graphic3d_TransformPers > & TransformPersistence () const
 Returns Transformation Persistence defining a special Local Coordinate system where this presentable object is located or NULL handle if not defined. Position of the object having Transformation Persistence is mutable and depends on camera position. The same applies to a bounding box of the object. More...
 
const Handle< Geom_Transformation > & LocalTransformationGeom () const
 Return the local transformation. Note that the local transformation of the object having Transformation Persistence is applied within Local Coordinate system defined by this Persistence. More...
 
void SetLocalTransformation (const gp_Trsf &theTrsf)
 Sets local transformation to theTransformation. Note that the local transformation of the object having Transformation Persistence is applied within Local Coordinate system defined by this Persistence. More...
 
void SetLocalTransformation (const Handle< Geom_Transformation > &theTrsf)
 Sets local transformation to theTransformation. Note that the local transformation of the object having Transformation Persistence is applied within Local Coordinate system defined by this Persistence. More...
 
Standard_Boolean HasTransformation () const
 Returns true if object has a transformation that is different from the identity. More...
 
const Handle< Geom_Transformation > & TransformationGeom () const
 Return the transformation taking into account transformation of parent object(s). Note that the local transformation of the object having Transformation Persistence is applied within Local Coordinate system defined by this Persistence. More...
 
const gp_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. More...
 
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. More...
 
const gp_GTrsfInversedTransformation () const
 Return inversed transformation. More...
 
const Handle< Geom_Transformation > & CombinedParentTransformation () const
 Return combined parent transformation. More...
 
const Handle< Graphic3d_SequenceOfHClipPlane > & ClipPlanes () const
 Get clip planes. More...
 
virtual void SetClipPlanes (const Handle< Graphic3d_SequenceOfHClipPlane > &thePlanes)
 Set clip planes for graphical clipping for all display mode presentations. The composition of clip planes truncates the rendering space to convex volume. Please be aware that number of supported clip plane is limited. The planes which exceed the limit are ignored. Besides of this, some planes can be already set in view where the object is shown: the number of these planes should be subtracted from limit to predict the maximum possible number of object clipping planes. More...
 
virtual void AddClipPlane (const Handle< Graphic3d_ClipPlane > &thePlane)
 Adds clip plane for graphical clipping for all display mode presentations. The composition of clip planes truncates the rendering space to convex volume. Please be aware that number of supported clip plane is limited. The planes which exceed the limit are ignored. Besides of this, some planes can be already set in view where the object is shown: the number of these planes should be subtracted from limit to predict the maximum possible number of object clipping planes. More...
 
virtual void RemoveClipPlane (const Handle< Graphic3d_ClipPlane > &thePlane)
 Removes previously added clip plane. More...
 
PrsMgr_PresentableObjectParent () const
 Returns parent of current object in scene hierarchy. More...
 
const PrsMgr_ListOfPresentableObjectsChildren () const
 Returns children of the current object. More...
 
virtual void AddChild (const Handle< PrsMgr_PresentableObject > &theObject)
 Makes theObject child of current object in scene hierarchy. More...
 
void AddChildWithCurrentTransformation (const Handle< PrsMgr_PresentableObject > &theObject)
 Makes theObject child of current object in scene hierarchy with keeping the current global transformation So the object keeps the same position/orientation in the global CS. More...
 
virtual void RemoveChild (const Handle< PrsMgr_PresentableObject > &theObject)
 Removes theObject from children of current object in scene hierarchy. More...
 
void RemoveChildWithRestoreTransformation (const Handle< PrsMgr_PresentableObject > &theObject)
 Removes theObject from children of current object in scene hierarchy with keeping the current global transformation. So the object keeps the same position/orientation in the global CS. More...
 
Standard_Boolean HasOwnPresentations () const
 Returns true if object should have own presentations. More...
 
virtual void BoundingBox (Bnd_Box &theBndBox)
 Returns bounding box of object correspondingly to its current display mode. This method requires presentation to be already computed, since it relies on bounding box of presentation structures, which are supposed to be same/close amongst different display modes of this object. More...
 
void SetIsoOnTriangulation (const Standard_Boolean theIsEnabled)
 Enables or disables on-triangulation build of isolines according to the flag given. More...
 
Aspect_TypeOfFacingModel CurrentFacingModel () const
 Returns the current facing model which is in effect. More...
 
void SetCurrentFacingModel (const Aspect_TypeOfFacingModel theModel=Aspect_TOFM_BOTH_SIDE)
 change the current facing model apply on polygons for SetColor(), SetTransparency(), SetMaterial() methods default facing model is Aspect_TOFM_TWO_SIDE. This mean that attributes is applying both on the front and back face. More...
 
Standard_Boolean HasColor () const
 Returns true if the Interactive Object has color. More...
 
virtual void Color (Quantity_Color &theColor) const
 Returns the color setting of the Interactive Object. More...
 
virtual void SetColor (const Quantity_Color &theColor)
 Only the interactive object knowns which Drawer attribute is affected by the color, if any (ex: for a wire,it's the wireaspect field of the drawer, but for a vertex, only the point aspect field is affected by the color). WARNING : Do not forget to set the corresponding fields here (hasOwnColor and myDrawer->SetColor()) More...
 
virtual void UnsetColor ()
 Removes color settings. Only the Interactive Object knows which Drawer attribute is affected by the color setting. For a wire, for example, wire aspect is the attribute affected. For a vertex, however, only point aspect is affected by the color setting. More...
 
Standard_Boolean HasWidth () const
 Returns true if the Interactive Object has width. More...
 
Standard_Real Width () const
 Returns the width setting of the Interactive Object. More...
 
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. More...
 
virtual void UnsetWidth ()
 Reset width to default value. More...
 
Standard_Boolean HasMaterial () const
 Returns true if the Interactive Object has a setting for material. More...
 
virtual Graphic3d_NameOfMaterial Material () const
 Returns the current material setting as enumeration value. More...
 
virtual void SetMaterial (const Graphic3d_MaterialAspect &aName)
 Sets the material aMat defining this display attribute for the interactive object. Material aspect determines shading aspect, color and transparency of visible entities. More...
 
virtual void UnsetMaterial ()
 Removes the setting for material. More...
 
Standard_Boolean IsTransparent () const
 Returns true if there is a transparency setting. More...
 
virtual Standard_Real Transparency () const
 Returns the transparency setting. This will be between 0.0 and 1.0. At 0.0 an object will be totally opaque, and at 1.0, fully transparent. More...
 
virtual void SetTransparency (const Standard_Real aValue=0.6)
 Attributes a setting aValue for transparency. The transparency value should be between 0.0 and 1.0. At 0.0 an object will be totally opaque, and at 1.0, fully transparent. Warning At a value of 1.0, there may be nothing visible. More...
 
virtual void UnsetTransparency ()
 Removes the transparency setting. The object is opaque by default. More...
 
virtual Standard_Boolean HasPolygonOffsets () const
 Returns Standard_True if <myDrawer> has non-null shading aspect. More...
 
virtual void PolygonOffsets (Standard_Integer &aMode, Standard_ShortReal &aFactor, Standard_ShortReal &aUnits) const
 Retrieves current polygon offsets settings from <myDrawer>. More...
 
virtual void SetPolygonOffsets (const Standard_Integer aMode, const Standard_ShortReal aFactor=1.0, const Standard_ShortReal aUnits=0.0)
 Sets up polygon offsets for this object. More...
 
virtual void UnsetAttributes ()
 Clears settings provided by the drawing tool aDrawer. More...
 
void ToBeUpdated (TColStd_ListOfInteger &ListOfMode) const
 gives the list of modes which are flagged "to be updated". More...
 
void SetClipPlanes (const Graphic3d_SequenceOfHClipPlane &thePlanes)
 
void SetTransformPersistence (const Graphic3d_TransModeFlags theMode, const gp_Pnt &thePoint=gp_Pnt(0.0, 0.0, 0.0))
 Sets up Transform Persistence Mode for this object. This function used to lock in object position, rotation and / or zooming relative to camera position. Object will be drawn in the origin setted by thePoint parameter (except Graphic3d_TMF_TriedronPers flag. More...
 
Graphic3d_TransModeFlags GetTransformPersistenceMode () const
 Gets Transform Persistence Mode for this object. More...
 
gp_Pnt GetTransformPersistencePoint () const
 Gets point of transform persistence for this object. More...
 
- Public Member Functions inherited from Standard_Transient
 Standard_Transient ()
 Empty constructor. More...
 
 Standard_Transient (const Standard_Transient &)
 Copy constructor – does nothing. More...
 
Standard_Transientoperator= (const Standard_Transient &)
 Assignment operator, needed to avoid copying reference counter. More...
 
virtual ~Standard_Transient ()
 Destructor must be virtual. More...
 
virtual void Delete () const
 Memory deallocator for transient classes. More...
 
virtual const opencascade::handle< Standard_Type > & DynamicType () const
 Returns a type descriptor about this object. More...
 
Standard_Boolean IsInstance (const opencascade::handle< Standard_Type > &theType) const
 Returns a true value if this is an instance of Type. More...
 
Standard_Boolean IsInstance (const Standard_CString theTypeName) const
 Returns a true value if this is an instance of TypeName. More...
 
Standard_Boolean IsKind (const opencascade::handle< Standard_Type > &theType) const
 Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism. More...
 
Standard_Boolean IsKind (const Standard_CString theTypeName) const
 Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism. More...
 
Standard_TransientThis () const
 Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero. More...
 
Standard_Integer GetRefCount () const
 Get the reference counter of this object. More...
 
void IncrementRefCounter () const
 Increments the reference counter of this object. More...
 
Standard_Integer DecrementRefCounter () const
 Decrements the reference counter of this object; returns the decremented value. More...
 

Protected Attributes

Auxiliary classes to fill presentation with proper primitives
Axis myAxes [3]
 Tree axes of the manipulator. More...
 
Sphere myCenter
 Visual part displaying the center sphere of the manipulator. More...
 
gp_Ax2 myPosition
 Position of the manipulator object. it displays its location and position of its axes. More...
 
Standard_Integer myCurrentIndex
 Index of active axis. More...
 
AIS_ManipulatorMode myCurrentMode
 Name of active manipulation mode. More...
 
Standard_Boolean myIsActivationOnDetection
 Manual activation of modes (not on parts selection). More...
 
Standard_Boolean myIsZoomPersistentMode
 Zoom persistence mode activation. More...
 
BehaviorOnTransform myBehaviorOnTransform
 Behavior settings applied on manipulator when transforming an object. More...
 
Fields for interactive transformation. Fields only for internal needs. They do not have public interface.
NCollection_Sequence< gp_TrsfmyStartTrsfs
 Owning object transformation for start. It is used internally. More...
 
Standard_Boolean myHasStartedTransformation
 Shows if transformation is processed (sequential calls of Transform()). More...
 
gp_Ax2 myStartPosition
 Owning object transformation for start. It is used internally. More...
 
gp_Pnt myStartPick
 Start position of manipulator. More...
 
Standard_Real myPrevState
 3d point corresponding to start mouse pick. More...
 
Handle< Prs3d_ShadingAspectmyHighlightAspect
 Previous value of angle during rotation. More...
 
Handle< Prs3d_ShadingAspectmyDraggerHighlight
 Aspect used to color sector part when it's selected. More...
 
- Protected Attributes inherited from AIS_InteractiveObject
AIS_InteractiveContextmyCTXPtr
 pointer to Interactive Context, where object is currently displayed; More...
 
Handle< Standard_TransientmyOwner
 application-specific owner object More...
 
- Protected Attributes inherited from SelectMgr_SelectableObject
SelectMgr_SequenceOfSelection myselections
 list of selections More...
 
Handle< Prs3d_PresentationmySelectionPrs
 optional presentation for highlighting selected object More...
 
Handle< Prs3d_PresentationmyHilightPrs
 optional presentation for highlighting detected object More...
 
Standard_Integer myGlobalSelMode
 global selection mode More...
 
Standard_Integer mycurrent
 [deprecated] iterator value More...
 
Standard_Boolean myAutoHilight
 auto-highlighting flag defining More...
 
- Protected Attributes inherited from PrsMgr_PresentableObject
PrsMgr_PresentableObjectmyParent
 pointer to the parent object More...
 
PrsMgr_Presentations myPresentations
 list of presentations More...
 
Handle< Graphic3d_SequenceOfHClipPlanemyClipPlanes
 sequence of object-specific clipping planes More...
 
Handle< Prs3d_DrawermyDrawer
 main presentation attributes More...
 
Handle< Prs3d_DrawermyHilightDrawer
 (optional) custom presentation attributes for highlighting selected object More...
 
Handle< Prs3d_DrawermyDynHilightDrawer
 (optional) custom presentation attributes for highlighting detected object More...
 
Handle< Graphic3d_TransformPersmyTransformPersistence
 transformation persistence More...
 
Handle< Geom_TransformationmyLocalTransformation
 local transformation relative to parent object More...
 
Handle< Geom_TransformationmyTransformation
 absolute transformation of this object (combined parents + local transformations) More...
 
Handle< Geom_TransformationmyCombinedParentTransform
 transformation of parent object (combined for all parents) More...
 
PrsMgr_ListOfPresentableObjects myChildren
 list of children More...
 
gp_GTrsf myInvTransformation
 inversion of absolute transformation (combined parents + local transformations) More...
 
PrsMgr_TypeOfPresentation3d myTypeOfPresentation3d
 presentation type More...
 
Aspect_TypeOfFacingModel myCurrentFacingModel
 current facing model More...
 
Standard_ShortReal myOwnWidth
 custom width value More...
 
Standard_Boolean hasOwnColor
 own color flag More...
 
Standard_Boolean hasOwnMaterial
 own material flag More...
 
Standard_Boolean myInfiniteState
 infinite flag More...
 
Standard_Boolean myIsMutable
 mutable flag More...
 
Standard_Boolean myHasOwnPresentations
 flag indicating if object should have own presentations More...
 

Presentation computation

virtual void Compute (const Handle< PrsMgr_PresentationManager3d > &thePrsMgr, const Handle< Prs3d_Presentation > &thePrs, const Standard_Integer theMode=0) override
 Fills presentation. More...
 
virtual void ComputeSelection (const Handle< SelectMgr_Selection > &theSelection, const Standard_Integer theMode) override
 Computes selection sensitive zones (triangulation) for manipulator. More...
 
virtual Standard_Boolean IsAutoHilight () const override
 Disables auto highlighting to use HilightSelected() and HilightOwnerWithColor() overridden methods. More...
 
virtual void ClearSelected () override
 Method which clear all selected owners belonging to this selectable object ( for fast presentation draw ). More...
 
virtual void HilightSelected (const Handle< PrsMgr_PresentationManager3d > &thePM, const SelectMgr_SequenceOfOwner &theSeq) override
 Method which draws selected owners ( for fast presentation draw ). More...
 
virtual void HilightOwnerWithColor (const Handle< PrsMgr_PresentationManager3d > &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 ). More...
 
void init ()
 Fills presentation. More...
 
void updateTransformation ()
 Fills presentation. More...
 
Handle< Prs3d_PresentationgetHighlightPresentation (const Handle< SelectMgr_EntityOwner > &theOwner) const
 Fills presentation. More...
 
Handle< Graphic3d_GroupgetGroup (const Standard_Integer theIndex, const AIS_ManipulatorMode theMode) const
 Fills presentation. More...
 
void attachToBox (const Bnd_Box &theBox)
 Fills presentation. More...
 
void adjustSize (const Bnd_Box &theBox)
 Fills presentation. More...
 
void setTransformPersistence (const Handle< Graphic3d_TransformPers > &theTrsfPers)
 Fills presentation. More...
 
virtual void setLocalTransformation (const Handle< Geom_Transformation > &theTrsf) override
 Redefines local transformation management method to inform user of inproper use. More...
 

Additional Inherited Members

- Public Types inherited from Standard_Transient
typedef void base_type
 Returns a type descriptor about this object. More...
 
- Static Public Member Functions inherited from Standard_Transient
static const char * get_type_name ()
 Returns a type descriptor about this object. More...
 
static const opencascade::handle< Standard_Type > & get_type_descriptor ()
 Returns type descriptor of Standard_Transient class. More...
 
- Protected Member Functions inherited from AIS_InteractiveObject
 AIS_InteractiveObject (const PrsMgr_TypeOfPresentation3d aTypeOfPresentation3d=PrsMgr_TOP_AllView)
 The TypeOfPresention3d means that the interactive object may have a presentation dependant of the view of Display. More...
 
- Protected Member Functions inherited from SelectMgr_SelectableObject
 SelectMgr_SelectableObject (const PrsMgr_TypeOfPresentation3d aTypeOfPresentation3d=PrsMgr_TOP_AllView)
 Protected empty constructor. More...
 
void setGlobalSelMode (const Standard_Integer theMode)
 Override global selection mode. More...
 
virtual void UpdateClipping () override
 Update clipping planes state. More...
 
virtual void updateSelection (const Standard_Integer theMode)
 Sets update status FULL to selections of the object. Must be used as the only method of UpdateSelection from outer classes to prevent BVH structures from being outdated. More...
 
- Protected Member Functions inherited from PrsMgr_PresentableObject
void Update (Standard_Boolean theToIncludeHidden=Standard_False)
 Recomputes all presentations of the object. More...
 
void Update (Standard_Integer theMode, Standard_Boolean theToClearOther)
 Recomputes the presentation in the given mode. More...
 
 PrsMgr_PresentableObject (const PrsMgr_TypeOfPresentation3d aTypeOfPresentation3d=PrsMgr_TOP_AllView)
 Protected empty constructor. More...
 
virtual ~PrsMgr_PresentableObject ()
 Destructor. More...
 
virtual void Fill (const Handle< PrsMgr_PresentationManager > &thePrsMgr, const Handle< PrsMgr_Presentation > &thePrs, const Standard_Integer theMode)
 Fills the given 3D view presentation for specified display mode using Compute() method. In addition, configures other properties of presentation (transformation, clipping planes). More...
 
virtual void Compute (const Handle< Prs3d_Projector > &theProjector, const Handle< Prs3d_Presentation > &thePrs)
 Calculates the 3D view presentation. Each of the views in the viewer and every modification such as rotation, for example, entails recalculation. It must be redefined to implement hidden line removal for the object. The user never calls this method himself. This is done via the InteractiveContext object and is dependent on the point of view from which the object is displayed. More...
 
virtual void Compute (const Handle< Prs3d_Projector > &theProjector, const Handle< Geom_Transformation > &theTrsf, const Handle< Prs3d_Presentation > &thePrs)
 Calculates the 3D view presentation. A point of view is provided by the projector, and the geometric transformation which has transformed associated presentable objects is specified by transformation. This function is to be used in case where a hidden line removal display cannot be calculated automatically. This occurs when associated presentable objects have been transformed geometrically, but not translated. Warning! The transformation must be applied to the object before computation. More...
 
Standard_Boolean UpdatePresentations (Standard_Boolean theToIncludeHidden=Standard_False)
 Recomputes invalidated presentations of the object. More...
 
virtual void SetCombinedParentTransform (const Handle< Geom_Transformation > &theTrsf)
 Sets myCombinedParentTransform to theTransformation. Thus object receives transformation from parent node and able to derive its own. More...
 
void recomputeComputed () const
 Recompute computed (HLR) presentations (when view is in computed mode). More...
 
void replaceAspects (const Graphic3d_MapOfAspectsToAspects &theMap)
 Replace aspects of existing (computed) presentation groups, so that the new aspects can be applied without recomputing presentation. It is NOT recommended approach, because user has to fill such map and then search for each occurrence in computed groups. The recommended approach is computing presentation with necessary customized aspects, and then modify them directly followed by SynchronizeAspects() call. More...
 
- Static Protected Member Functions inherited from PrsMgr_PresentableObject
static const gp_TrsfgetIdentityTrsf ()
 Return the identity transformation. More...
 

Detailed Description

Interactive object class to manipulate local transformation of another interactive object or a group of objects via mouse. It manages three types of manipulations in 3D space:

Constructor & Destructor Documentation

◆ AIS_Manipulator() [1/2]

AIS_Manipulator::AIS_Manipulator ( )

Constructs a manipulator object with default placement and all parts to be displayed.

◆ AIS_Manipulator() [2/2]

AIS_Manipulator::AIS_Manipulator ( const gp_Ax2 thePosition)

Constructs a manipulator object with input location and positions of axes and all parts to be displayed.

Member Function Documentation

◆ ActiveMode()

AIS_ManipulatorMode AIS_Manipulator::ActiveMode ( ) const
inline
Returns
poition of manipulator interactive object.

◆ adjustSize()

void AIS_Manipulator::adjustSize ( const Bnd_Box theBox)
protected

Fills presentation.

Note
Manipulator presentation does not use display mode and for all modes has the same presentation.

◆ Attach() [1/2]

void AIS_Manipulator::Attach ( const Handle< AIS_InteractiveObject > &  theObject,
const OptionsForAttach theOptions = OptionsForAttach() 
)

Attaches himself to the input interactive object and become displayed in the same context. It is placed in the center of object bounding box, and its size is adjusted to the object bounding box.

◆ Attach() [2/2]

void AIS_Manipulator::Attach ( const Handle< AIS_ManipulatorObjectSequence > &  theObject,
const OptionsForAttach theOptions = OptionsForAttach() 
)

Attaches himself to the input interactive object group and become displayed in the same context. It become attached to the first object, baut manage manipulation of the whole group. It is placed in the center of object bounding box, and its size is adjusted to the object bounding box.

◆ attachToBox()

void AIS_Manipulator::attachToBox ( const Bnd_Box theBox)
protected

Fills presentation.

Note
Manipulator presentation does not use display mode and for all modes has the same presentation.

◆ ChangeTransformBehavior()

BehaviorOnTransform& AIS_Manipulator::ChangeTransformBehavior ( )
inline
Returns
behavior settings for transformation action of the manipulator.

◆ ClearSelected()

virtual void AIS_Manipulator::ClearSelected ( )
overridevirtual

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

Reimplemented from SelectMgr_SelectableObject.

◆ Compute()

virtual void AIS_Manipulator::Compute ( const Handle< PrsMgr_PresentationManager3d > &  thePrsMgr,
const Handle< Prs3d_Presentation > &  thePrs,
const Standard_Integer  theMode = 0 
)
overridevirtual

Fills presentation.

Note
Manipulator presentation does not use display mode and for all modes has the same presentation.

Implements PrsMgr_PresentableObject.

◆ ComputeSelection()

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

Computes selection sensitive zones (triangulation) for manipulator.

Parameters
theNode[in] Selection mode that is treated as transformation mode.

Implements SelectMgr_SelectableObject.

◆ DeactivateCurrentMode()

void AIS_Manipulator::DeactivateCurrentMode ( )

Make inactive the current selected manipulator part and reset current axis index and current mode. After its call HasActiveMode() returns false.

See also
HasActiveMode()

◆ Detach()

void AIS_Manipulator::Detach ( )

Detaches himself from the owner object, and removes itself from context.

◆ EnableMode()

void AIS_Manipulator::EnableMode ( const AIS_ManipulatorMode  theMode)

Enable manipualtion mode.

Warning
It activates selection mode in the current context. If manipulator is not displayed, no mode will be activated.

◆ getGroup()

Handle< Graphic3d_Group > AIS_Manipulator::getGroup ( const Standard_Integer  theIndex,
const AIS_ManipulatorMode  theMode 
) const
protected

Fills presentation.

Note
Manipulator presentation does not use display mode and for all modes has the same presentation.

◆ getHighlightPresentation()

Handle< Prs3d_Presentation > AIS_Manipulator::getHighlightPresentation ( const Handle< SelectMgr_EntityOwner > &  theOwner) const
protected

Fills presentation.

Note
Manipulator presentation does not use display mode and for all modes has the same presentation.

◆ HasActiveMode()

Standard_Boolean AIS_Manipulator::HasActiveMode ( ) const
inline
Returns
true if some part of manipulator is selected (transformation mode is active, and owning object can be transformed).

◆ HasActiveTransformation()

Standard_Boolean AIS_Manipulator::HasActiveTransformation ( )
inline

◆ HilightOwnerWithColor()

virtual void AIS_Manipulator::HilightOwnerWithColor ( const Handle< PrsMgr_PresentationManager3d > &  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_Manipulator::HilightSelected ( const Handle< PrsMgr_PresentationManager3d > &  thePM,
const SelectMgr_SequenceOfOwner theSeq 
)
overridevirtual

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

Reimplemented from SelectMgr_SelectableObject.

◆ init()

void AIS_Manipulator::init ( )
protected

Fills presentation.

Note
Manipulator presentation does not use display mode and for all modes has the same presentation.

◆ IsAttached()

Standard_Boolean AIS_Manipulator::IsAttached ( ) const
inline
Returns
true if manipulator is attached to some interactive object (has owning object).

◆ IsAutoHilight()

virtual Standard_Boolean AIS_Manipulator::IsAutoHilight ( ) const
inlineoverridevirtual

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

Reimplemented from SelectMgr_SelectableObject.

◆ IsModeActivationOnDetection()

Standard_Boolean AIS_Manipulator::IsModeActivationOnDetection ( ) const
inline
Returns
true if manual mode activation is enabled.

◆ Object() [1/2]

Handle< AIS_InteractiveObject > AIS_Manipulator::Object ( ) const
Returns
the first (leading) object of the owning objects.

◆ Object() [2/2]

Handle< AIS_InteractiveObject > AIS_Manipulator::Object ( const Standard_Integer  theIndex) const
Returns
one of the owning objects.
Warning
raises program error if theIndex is more than owning objects count or less than 1.

◆ Objects()

Handle< AIS_ManipulatorObjectSequence > AIS_Manipulator::Objects ( ) const
Returns
all owning objects.

◆ ObjectTransformation()

Standard_Boolean AIS_Manipulator::ObjectTransformation ( const Standard_Integer  theX,
const Standard_Integer  theY,
const Handle< V3d_View > &  theView,
gp_Trsf theTrsf 
)

Computes transformation of parent object according to the active mode and input motion vector. You can use this method to get object transformation according to current mode or use own algorithm to implement any other tranformation for modes.

Returns
transformation of parent object.

◆ Position()

const gp_Ax2& AIS_Manipulator::Position ( ) const
inline
Returns
poition of manipulator interactive object.

◆ SetGap()

void AIS_Manipulator::SetGap ( const Standard_ShortReal  theValue)

Sets gaps between translator, scaler and rotator sub-presentations.

◆ setLocalTransformation()

virtual void AIS_Manipulator::setLocalTransformation ( const Handle< Geom_Transformation > &  theTrsf)
overrideprotectedvirtual

Redefines local transformation management method to inform user of inproper use.

Warning
this interactive object does not support setting custom local transformation, this class solely uses this property to implement visual positioning of the manipulator without need for recomputing presentation.
Invokes debug assertion in debug to catch incompatible usage of the method, silently does nothing in release mode.

Reimplemented from PrsMgr_PresentableObject.

◆ SetModeActivationOnDetection()

void AIS_Manipulator::SetModeActivationOnDetection ( const Standard_Boolean  theToEnable)
inline

Enables mode activation on detection (highlighting). By default, mode is activated on selection of manipulator part.

Warning
If this mode is enabled, selection of parts does nothing.

◆ SetPart() [1/2]

void AIS_Manipulator::SetPart ( const Standard_Integer  theAxisIndex,
const AIS_ManipulatorMode  theMode,
const Standard_Boolean  theIsEnabled 
)

Disable or enable visual parts for translation, rotation or scaling for some axis. By default all parts are enabled (will be displayed).

Warning
Enabling or disabling of visual parts of manipulator does not manage the manipulation (selection) mode.
Raises program error if axis index is < 0 or > 2.

◆ SetPart() [2/2]

void AIS_Manipulator::SetPart ( const AIS_ManipulatorMode  theMode,
const Standard_Boolean  theIsEnabled 
)

Disable or enable visual parts for translation, rotation or scaling for ALL axes. By default all parts are enabled (will be displayed).

Warning
Enabling or disabling of visual parts of manipulator does not manage the manipulation (selection) mode.
Raises program error if axis index is < 0 or > 2.

◆ SetPosition()

void AIS_Manipulator::SetPosition ( const gp_Ax2 thePosition)

Sets position of the manipulator object.

◆ SetSize()

void AIS_Manipulator::SetSize ( const Standard_ShortReal  theSideLength)

Sets size (length of side of the manipulator cubic bounding box.

◆ SetTransformBehavior()

void AIS_Manipulator::SetTransformBehavior ( const BehaviorOnTransform theSettings)
inline

Sets behavior settings for transformation action carried on the manipulator, whether it translates, rotates together with the transformed object or not.

◆ SetTransformPersistence()

virtual void AIS_Manipulator::SetTransformPersistence ( const Handle< Graphic3d_TransformPers > &  theTrsfPers)
overridevirtual

Redefines transform persistence management to setup transformation for sub-presentation of axes.

Warning
this interactive object does not support custom transformation persistence when using
See also
ZoomPersistence mode. In this mode the transformation persistence flags for presentations are overridden by this class.
Warning
Invokes debug assertion to catch incompatible usage of the method with
See also
ZoomPersistence mode, silently does nothing in release mode.
Warning
revise use of AdjustSize argument of of
See also
AttachToObjects method when enabling zoom persistence.

Reimplemented from PrsMgr_PresentableObject.

◆ setTransformPersistence()

void AIS_Manipulator::setTransformPersistence ( const Handle< Graphic3d_TransformPers > &  theTrsfPers)
protected

Fills presentation.

Note
Manipulator presentation does not use display mode and for all modes has the same presentation.

◆ SetZoomPersistence()

void AIS_Manipulator::SetZoomPersistence ( const Standard_Boolean  theToEnable)

Enable or disable zoom persistence mode for the manipulator. With this mode turned on the presentation will keep fixed screen size.

Warning
when turned on this option overrides transform persistence properties and local transformation to achieve necessary visual effect.
revise use of AdjustSize argument of of
See also
AttachToObjects method when enabling zoom persistence.

◆ Size()

Standard_ShortReal AIS_Manipulator::Size ( void  ) const
inline
Returns
poition of manipulator interactive object.

◆ StartTransform()

void AIS_Manipulator::StartTransform ( const Standard_Integer  theX,
const Standard_Integer  theY,
const Handle< V3d_View > &  theView 
)

Init start (reference) transformation.

Warning
It is used in chain with StartTransform-Transform(gp_Trsf)-StopTransform and is used only for custom transform set. If Transform(const Standard_Integer, const Standard_Integer) is used, initial data is set automatically, and it is reset on DeactivateCurrentMode call if it is not reset yet.

◆ StartTransformation() [1/2]

gp_Trsf AIS_Manipulator::StartTransformation ( ) const
inline

◆ StartTransformation() [2/2]

gp_Trsf AIS_Manipulator::StartTransformation ( Standard_Integer  theIndex) const
inline

◆ StopTransform()

void AIS_Manipulator::StopTransform ( const Standard_Boolean  theToApply = Standard_True)

Reset start (reference) transformation.

Parameters
theToApply[in] option to apply or to cancel the started transformation.
Warning
It is used in chain with StartTransform-Transform(gp_Trsf)-StopTransform and is used only for custom transform set.

◆ Transform() [1/2]

void AIS_Manipulator::Transform ( const gp_Trsf aTrsf)

Apply to the owning objects the input transformation.

Remarks
The transformation is set using SetLocalTransformation for owning objects. The location of the manipulator is stored also in Local Transformation, so that there's no need to redisplay objects.
Warning
It is used in chain with StartTransform-Transform(gp_Trsf)-StopTransform and is used only for custom transform set.
It will does nothing if transformation is not initiated (with StartTransform() call).

◆ Transform() [2/2]

gp_Trsf AIS_Manipulator::Transform ( const Standard_Integer  theX,
const Standard_Integer  theY,
const Handle< V3d_View > &  theView 
)

Apply transformation made from mouse moving from start position (save on the first Tranform() call and reset on DeactivateCurrentMode() call.) to the in/out mouse position (theX, theY)

◆ TransformBehavior()

const BehaviorOnTransform& AIS_Manipulator::TransformBehavior ( ) const
inline
Returns
behavior settings for transformation action of the manipulator.

◆ updateTransformation()

void AIS_Manipulator::updateTransformation ( )
protected

Fills presentation.

Note
Manipulator presentation does not use display mode and for all modes has the same presentation.

◆ ZoomPersistence()

Standard_Boolean AIS_Manipulator::ZoomPersistence ( ) const
inline

Returns state of zoom persistence mode, whether it turned on or off.

Field Documentation

◆ myAxes

Axis AIS_Manipulator::myAxes[3]
protected

Tree axes of the manipulator.

◆ myBehaviorOnTransform

BehaviorOnTransform AIS_Manipulator::myBehaviorOnTransform
protected

Behavior settings applied on manipulator when transforming an object.

◆ myCenter

Sphere AIS_Manipulator::myCenter
protected

Visual part displaying the center sphere of the manipulator.

◆ myCurrentIndex

Standard_Integer AIS_Manipulator::myCurrentIndex
protected

Index of active axis.

◆ myCurrentMode

AIS_ManipulatorMode AIS_Manipulator::myCurrentMode
protected

Name of active manipulation mode.

◆ myDraggerHighlight

Handle< Prs3d_ShadingAspect > AIS_Manipulator::myDraggerHighlight
protected

Aspect used to color sector part when it's selected.

◆ myHasStartedTransformation

Standard_Boolean AIS_Manipulator::myHasStartedTransformation
protected

Shows if transformation is processed (sequential calls of Transform()).

◆ myHighlightAspect

Handle< Prs3d_ShadingAspect > AIS_Manipulator::myHighlightAspect
protected

Previous value of angle during rotation.

Aspect used to color current detected part and current selected part.

◆ myIsActivationOnDetection

Standard_Boolean AIS_Manipulator::myIsActivationOnDetection
protected

Manual activation of modes (not on parts selection).

◆ myIsZoomPersistentMode

Standard_Boolean AIS_Manipulator::myIsZoomPersistentMode
protected

Zoom persistence mode activation.

◆ myPosition

gp_Ax2 AIS_Manipulator::myPosition
protected

Position of the manipulator object. it displays its location and position of its axes.

◆ myPrevState

Standard_Real AIS_Manipulator::myPrevState
protected

3d point corresponding to start mouse pick.

◆ myStartPick

gp_Pnt AIS_Manipulator::myStartPick
protected

Start position of manipulator.

◆ myStartPosition

gp_Ax2 AIS_Manipulator::myStartPosition
protected

Owning object transformation for start. It is used internally.

◆ myStartTrsfs

NCollection_Sequence<gp_Trsf> AIS_Manipulator::myStartTrsfs
protected

Owning object transformation for start. It is used internally.


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