0025180: Visualization - Homogeneous transformation API in TKV3d
[occt.git] / src / AIS / AIS_Manipulator.hxx
CommitLineData
625e1958 1// Created on: 2015-12-23
2// Created by: Anastasia BORISOVA
3// Copyright (c) 2015 OPEN CASCADE SAS
4//
5// This file is part of Open CASCADE Technology software library.
6//
7// This library is free software; you can redistribute it and/or modify it under
8// the terms of the GNU Lesser General Public License version 2.1 as published
9// by the Free Software Foundation, with special exception defined in the file
10// OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
11// distribution for complete text of the license and disclaimer of any warranty.
12//
13// Alternatively, this file may be used under the terms of Open CASCADE
14// commercial license or contractual agreement.
15
16#ifndef _AIS_Manipulator_HeaderFile
17#define _AIS_Manipulator_HeaderFile
18
19#include <AIS_InteractiveObject.hxx>
20#include <AIS_ManipulatorMode.hxx>
21#include <gp.hxx>
22#include <gp_Ax1.hxx>
23#include <gp_Dir.hxx>
24#include <gp_Pnt.hxx>
25#include <Graphic3d_ArrayOfQuadrangles.hxx>
26#include <Graphic3d_ArrayOfTriangles.hxx>
27#include <Graphic3d_Group.hxx>
28#include <NCollection_HSequence.hxx>
29#include <Poly_Triangulation.hxx>
30#include <V3d_View.hxx>
31#include <Standard_Version.hxx>
32#include <Standard_DefineHandle.hxx>
33NCOLLECTION_HSEQUENCE(AIS_ManipulatorObjectSequence, Handle(AIS_InteractiveObject));
34
35DEFINE_STANDARD_HANDLE (AIS_Manipulator, AIS_InteractiveObject)
36
37//! Interactive object class to manipulate local transformation of another interactive
38//! object or a group of objects via mouse.
39//! It manages three types of manipulations in 3D space:
40//! - translation through axis
41//! - scaling within axis
42//! - rotation around axis
43//! To enable one of this modes, selection mode (from 1 to 3) is to be activated.
44//! There are three orthogonal transformation axes defined by position property of
45//! the manipulator. Particular transformation mode can be disabled for each
46//! of the axes or all of them. Furthermore each of the axes can be hidden or
47//! made visible.
48//! The following steps demonstrate how to attach, configure and use manipulator
49//! for an interactive object:
50//! Step 1. Create manipulator object and adjust it appearance:
51//! @code
52//! Handle(AIS_Manipulator) aManipulator = new AIS_Manipulator();
53//! aManipulator->SetPart (0, AIS_Manipulator::Scaling, Standard_False);
54//! aManipulator->SetPart (1, AIS_Manipulator::Rotation, Standard_False);
55//! // Attach manipulator to already displayed object and manage manipulation modes
56//! aManipulator->AttachToObject (anAISObject);
57//! aManipulator->EnableMode (AIS_Manipulator::Translation);
58//! aManipulator->EnableMode (AIS_Manipulator::Rotation);
59//! aManipulator->EnableMode (AIS_Manipulator::Scaling);
60//! @endcode
61//! Note that you can enable only one manipulation mode but have all visual parts displayed.
62//! This code allows you to view manipulator and select its manipulation parts.
63//! Note that manipulator activates mode on part selection.
64//! If this mode is activated, no selection will be performed for manipulator.
65//! It can be activated with highlighting. To enable this:
66//! @code
67//! aManipulator->SetModeActivationOnDetection (Standard_True);
68//! @endcode
69//! Step 2. To perform transformation of object use next code in your event processing chain:
70//! @code
71//! // catch mouse button down event
72//! if (aManipulator->HasActiveMode())
73//! {
74//! aManipulator->StartTransform (anXPix, anYPix, aV3dView);
75//! }
76//! ...
77//! // or track mouse move event
78//! if (aManipulator->HasActiveMode())
79//! {
80//! aManipulator->Transform (anXPix, anYPix, aV3dView);
81//! aV3dView->Redraw();
82//! }
83//! ...
84//! // or catch mouse button up event (apply) or escape event (cancel)
85//! aManipulator->StopTransform(/*Standard_Boolean toApply*/);
86//! @endcode
87//! Step 3. To deactivate current manipulation mode use:
88//! @code aManipulator->DeactivateCurrentMode();
89//! @endcode
90//! Step 4. To detach manipulator from object use:
91//! @code
92//! aManipulator->Detach();
93//! @endcode
94//! The last method erases manipulator object.
95//! @warning
96//! On construction an instance of AIS_Manipulator object is bound to Graphic3d_ZLayerId_Topmost layer,
97//! so make sure to call for your AIS_InteractiveContext the method MainSelector()->SetPickClosest (Standard_False)
98//! otherwise you may notice issues with activation of modes.
99class AIS_Manipulator : public AIS_InteractiveObject
100{
101public:
102
103 //! Constructs a manipulator object with default placement and all parts to be displayed.
104 Standard_EXPORT AIS_Manipulator();
105
106 //! Constructs a manipulator object with input location and positions of axes and all parts to be displayed.
107 Standard_EXPORT AIS_Manipulator (const gp_Ax2& thePosition);
108
109 //! Destructor.
110 Standard_EXPORT virtual ~AIS_Manipulator() {}
111
112 //! Disable or enable visual parts for translation, rotation or scaling for some axis.
113 //! By default all parts are enabled (will be displayed).
114 //! @warning Enabling or disabling of visual parts of manipulator does not manage the manipulation (selection) mode.
115 //! @warning Raises program error if axis index is < 0 or > 2.
116 Standard_EXPORT void SetPart (const Standard_Integer theAxisIndex, const AIS_ManipulatorMode theMode, const Standard_Boolean theIsEnabled);
117
118 //! Behavior settings to be applied when performing transformation:
119 //! - FollowTranslation - whether the manipulator will be moved together with an object.
120 //! - FollowRotation - whether the manipulator will be rotated together with an object.
121 struct OptionsForAttach {
122
123 OptionsForAttach() : AdjustPosition (Standard_True), AdjustSize (Standard_False), EnableModes (Standard_True) {}
124 OptionsForAttach& SetAdjustPosition (const Standard_Boolean theApply) { AdjustPosition = theApply; return *this; }
125 OptionsForAttach& SetAdjustSize (const Standard_Boolean theApply) { AdjustSize = theApply; return *this; }
126 OptionsForAttach& SetEnableModes (const Standard_Boolean theApply) { EnableModes = theApply; return *this; }
127
128 Standard_Boolean AdjustPosition;
129 Standard_Boolean AdjustSize;
130 Standard_Boolean EnableModes;
131 };
132
133 //! Attaches himself to the input interactive object and become displayed in the same context.
134 //! It is placed in the center of object bounding box, and its size is adjusted to the object bounding box.
135 Standard_EXPORT void Attach (const Handle(AIS_InteractiveObject)& theObject, const OptionsForAttach& theOptions = OptionsForAttach());
136
137 //! Attaches himself to the input interactive object group and become displayed in the same context.
138 //! It become attached to the first object, baut manage manipulation of the whole group.
139 //! It is placed in the center of object bounding box, and its size is adjusted to the object bounding box.
140 Standard_EXPORT void Attach (const Handle(AIS_ManipulatorObjectSequence)& theObject, const OptionsForAttach& theOptions = OptionsForAttach());
141
142 //! Enable manipualtion mode.
143 //! @warning It activates selection mode in the current context.
144 //! If manipulator is not displayed, no mode will be activated.
145 Standard_EXPORT void EnableMode (const AIS_ManipulatorMode theMode);
146
147 //! Enables mode activation on detection (highlighting).
148 //! By default, mode is activated on selection of manipulator part.
149 //! @warning If this mode is enabled, selection of parts does nothing.
150 void SetModeActivationOnDetection (const Standard_Boolean theToEnable)
151 {
152 myIsActivationOnDetection = theToEnable;
153 }
154
155 //! @return true if manual mode activation is enabled.
156 Standard_Boolean IsModeActivationOnDetection() const
157 {
158 return myIsActivationOnDetection;
159 }
160
161public:
162
163 //! Init start (reference) transformation.
164 //! @warning It is used in chain with StartTransform-Transform(gp_Trsf)-StopTransform
165 //! and is used only for custom transform set. If Transform(const Standard_Integer, const Standard_Integer) is used,
166 //! initial data is set automatically, and it is reset on DeactivateCurrentMode call if it is not reset yet.
167 Standard_EXPORT void StartTransform (const Standard_Integer theX, const Standard_Integer theY, const Handle(V3d_View)& theView);
168
169 //! Apply to the owning objects the input transformation.
170 //! @remark The transformation is set using SetLocalTransformation for owning objects.
171 //! The location of the manipulator is stored also in Local Transformation,
172 //! so that there's no need to redisplay objects.
173 //! @warning It is used in chain with StartTransform-Transform(gp_Trsf)-StopTransform
174 //! and is used only for custom transform set.
175 //! @warning It will does nothing if transformation is not initiated (with StartTransform() call).
176 Standard_EXPORT void Transform (const gp_Trsf& aTrsf);
177
178 //! Reset start (reference) transformation.
179 //! @param theToApply [in] option to apply or to cancel the started transformation.
180 //! @warning It is used in chain with StartTransform-Transform(gp_Trsf)-StopTransform
181 //! and is used only for custom transform set.
182 Standard_EXPORT void StopTransform (const Standard_Boolean theToApply = Standard_True);
183
184 //! Apply transformation made from mouse moving from start position
185 //! (save on the first Tranform() call and reset on DeactivateCurrentMode() call.)
186 //! to the in/out mouse position (theX, theY)
187 Standard_EXPORT gp_Trsf Transform (const Standard_Integer theX, const Standard_Integer theY,
188 const Handle(V3d_View)& theView);
189
190 //! Computes transformation of parent object according to the active mode and input motion vector.
191 //! You can use this method to get object transformation according to current mode or use own algorithm
192 //! to implement any other tranformation for modes.
193 //! @return transformation of parent object.
194 Standard_EXPORT Standard_Boolean ObjectTransformation (const Standard_Integer theX, const Standard_Integer theY,
195 const Handle(V3d_View)& theView, gp_Trsf& theTrsf);
196
197 //! Make inactive the current selected manipulator part and reset current axis index and current mode.
198 //! After its call HasActiveMode() returns false.
199 //! @sa HasActiveMode()
200 Standard_EXPORT void DeactivateCurrentMode();
201
202 //! Detaches himself from the owner object, and removes itself from context.
203 Standard_EXPORT void Detach();
204
205 //! @return all owning objects.
206 Standard_EXPORT Handle(AIS_ManipulatorObjectSequence) Objects() const;
207
208 //! @return the first (leading) object of the owning objects.
209 Standard_EXPORT Handle(AIS_InteractiveObject) Object() const;
210
211 //! @return one of the owning objects.
212 //! @warning raises program error if theIndex is more than owning objects count or less than 1.
213 Standard_EXPORT Handle(AIS_InteractiveObject) Object (const Standard_Integer theIndex) const;
214
215 //! @return true if manipulator is attached to some interactive object (has owning object).
216 Standard_Boolean IsAttached() const { return HasOwner(); }
217
218 //! @return true if some part of manipulator is selected (tranformation mode is active, and owning object can be rtansformated).
219 Standard_Boolean HasActiveMode() const { return IsAttached() && myCurrentMode != AIS_MM_None; }
220
221 Standard_Boolean HasActiveTransformation() { return myHasStartedTransformation; }
222
223 gp_Trsf StartTransformation() const { return myStartTrsfs.Size() < 1 ? gp_Trsf() : myStartTrsfs(1); }
224
225 gp_Trsf StartTransformation (const Standard_Integer theIndex) const
226 {
227 Standard_ProgramError_Raise_if (theIndex < 1 || theIndex > Objects()->Upper(),
228 "AIS_Manipulator::StartTransformation(): theIndex is out of bounds");
229 return myStartTrsfs.Size() < 1 ? gp_Trsf() : myStartTrsfs (theIndex);
230 }
231
232public: //! @name Configuration of graphical transformations
233
234 //! Enable or disable zoom persistence mode for the manipulator. With
235 //! this mode turned on the presentation will keep fixed screen size.
236 //! @warning when turned on this option overrides transform persistence
237 //! properties and local transformation to achieve necessary visual effect.
238 //! @warning revise use of AdjustSize argument of of \sa AttachToObjects method
239 //! when enabling zoom persistence.
240 Standard_EXPORT void SetZoomPersistence (const Standard_Boolean theToEnable);
241
242 //! Returns state of zoom persistence mode, whether it turned on or off.
243 Standard_Boolean ZoomPersistence() const { return myIsZoomPersistentMode; }
244
245 //! Redefines transform persistence management to setup transformation for sub-presentation of axes.
246 //! @warning this interactive object does not support custom transformation persistence when
247 //! using \sa ZoomPersistence mode. In this mode the transformation persistence flags for
248 //! presentations are overriden by this class.
249 //! @warning Invokes debug assertion to catch incompatible usage of the method with \sa ZoomPersistence mode,
250 //! silently does nothing in release mode.
251 //! @warning revise use of AdjustSize argument of of \sa AttachToObjects method
252 //! when enabling zoom persistence.
778cd667 253 Standard_EXPORT virtual void SetTransformPersistence (const Handle(Graphic3d_TransformPers)& theTrsfPers) Standard_OVERRIDE;
625e1958 254
625e1958 255public: //! @name Setters for parameters
256
257 AIS_ManipulatorMode ActiveMode() const { return myCurrentMode; }
258
259 //! @return poition of manipulator interactive object.
260 const gp_Ax2& Position() const { return myPosition; }
261
262 //! Sets position of the manipulator object.
263 Standard_EXPORT void SetPosition (const gp_Ax2& thePosition);
264
265 Standard_ShortReal Size() const { return myAxes[0].Size(); }
266
267 //! Sets size (length of side of the manipulator cubic bounding box.
268 Standard_EXPORT void SetSize (const Standard_ShortReal theSideLength);
269
270 //! Sets gaps between translator, scaler and rotator sub-presentations.
271 Standard_EXPORT void SetGap (const Standard_ShortReal theValue);
272
273public:
274
275 //! Behavior settings to be applied when performing transformation:
276 //! - FollowTranslation - whether the manipulator will be moved together with an object.
277 //! - FollowRotation - whether the manipulator will be rotated together with an object.
278 struct BehaviorOnTransform {
279
280 BehaviorOnTransform() : FollowTranslation (Standard_True), FollowRotation (Standard_True) {}
281 BehaviorOnTransform& SetFollowTranslation (const Standard_Boolean theApply) { FollowTranslation = theApply; return *this; }
282 BehaviorOnTransform& SetFollowRotation (const Standard_Boolean theApply) { FollowRotation = theApply; return *this; }
283
284 Standard_Boolean FollowTranslation;
285 Standard_Boolean FollowRotation;
286 };
287
288 //! Sets behavior settings for transformation action carried on the manipulator,
289 //! whether it translates, rotates together with the transformed object or not.
290 void SetTransformBehavior (const BehaviorOnTransform& theSettings) { myBehaviorOnTransform = theSettings; }
291
292 //! @return behavior settings for transformation action of the manipulator.
293 BehaviorOnTransform& ChangeTransformBehavior() { return myBehaviorOnTransform; }
294
295 //! @return behavior settings for transformation action of the manipulator.
296 const BehaviorOnTransform& TransformBehavior() const { return myBehaviorOnTransform; }
297
298public: //! @name Presentation computation
299
300 //! Fills presentation.
301 //! @note Manipulator presentation does not use display mode and for all modes has the same presenatation.
302 Standard_EXPORT virtual void Compute (const Handle(PrsMgr_PresentationManager3d)& thePrsMgr,
303 const Handle(Prs3d_Presentation)& thePrs,
304 const Standard_Integer theMode = 0) Standard_OVERRIDE;
305
306 //! Computes selection sensitive zones (triangulation) for manipulator.
307 //! @param theNode [in] Seldction mode that is treated as transformation mode.
308 Standard_EXPORT virtual void ComputeSelection (const Handle(SelectMgr_Selection)& theSelection,
309 const Standard_Integer theMode) Standard_OVERRIDE;
310
311 //! Disables auto highlighting to use HilightSelected() and HilightOwnerWithColor() overriden methods.
312 Standard_EXPORT virtual Standard_Boolean IsAutoHilight() const Standard_OVERRIDE
313 {
314 return Standard_False;
315 }
316
317 //! Method which clear all selected owners belonging
318 //! to this selectable object ( for fast presentation draw ).
319 Standard_EXPORT virtual void ClearSelected() Standard_OVERRIDE;
320
321 //! Method which draws selected owners ( for fast presentation draw ).
322 Standard_EXPORT virtual void HilightSelected (const Handle(PrsMgr_PresentationManager3d)& thePM, const SelectMgr_SequenceOfOwner& theSeq) Standard_OVERRIDE;
323
324 //! Method which hilight an owner belonging to
325 //! this selectable object ( for fast presentation draw ).
326 Standard_EXPORT virtual void HilightOwnerWithColor (const Handle(PrsMgr_PresentationManager3d)& thePM, const Quantity_NameOfColor theColor, const Handle(SelectMgr_EntityOwner)& theOwner) Standard_OVERRIDE;
327
328protected:
329
330 Standard_EXPORT void init();
331
332 Standard_EXPORT void updateTransformation();
333
334 Standard_EXPORT Handle(Prs3d_Presentation) getHighlightPresentation (const Handle(SelectMgr_EntityOwner)& theOwner) const;
335
336 Standard_EXPORT Handle(Graphic3d_Group) getGroup (const Standard_Integer theIndex, const AIS_ManipulatorMode theMode) const;
337
338 Standard_EXPORT void attachToBox (const Bnd_Box& theBox);
339
340 Standard_EXPORT void adjustSize (const Bnd_Box& theBox);
341
778cd667 342 Standard_EXPORT void setTransformPersistence (const Handle(Graphic3d_TransformPers)& theTrsfPers);
625e1958 343
1f7f5a90 344 //! Redefines local transformation management method to inform user of inproper use.
345 //! @warning this interactive object does not support setting custom local transformation,
346 //! this class solely uses this property to implement visual positioning of the manipulator
347 //! without need for recomputing presentation.
348 //! @warning Invokes debug assertion in debug to catch incompatible usage of the
349 //! method, silently does nothing in release mode.
350 Standard_EXPORT virtual void setLocalTransformation (const Handle(Geom_Transformation)& theTrsf) Standard_OVERRIDE;
351 using AIS_InteractiveObject::SetLocalTransformation; // hide visibility
352
625e1958 353protected: //! @name Auxilliary classes to fill presentation with proper primitives
354
355 class Quadric
356 {
357 public:
358
359 virtual ~Quadric()
360 {
361 myTriangulation.Nullify();
362 myArray.Nullify();
363 }
364
365
366 const Handle(Poly_Triangulation)& Triangulation() const { return myTriangulation; }
367
368 const Handle(Graphic3d_ArrayOfTriangles)& Array() const { return myArray; }
369
370 protected:
371
372 Handle(Poly_Triangulation) myTriangulation;
373 Handle(Graphic3d_ArrayOfTriangles) myArray;
374 };
375
376 class Cylinder : public Quadric
377 {
378 public:
379
380 Cylinder()
381 : Quadric(),
382 myBottomRad(1.0f),
383 myTopRad(1.0f),
384 myHeight(1.0f)
385 { }
386
387 virtual ~Cylinder() {}
388
389 void Init (const Standard_ShortReal theBotRad, const Standard_ShortReal theTopRad,
390 const Standard_ShortReal theHeight,
391 const Standard_Integer theSlicesNb, const Standard_Integer theStacksNb,
392 const gp_Ax1& thePosition);
393
394 protected:
395
396 gp_Ax1 myPosition;
397 Standard_ShortReal myBottomRad;
398 Standard_ShortReal myTopRad;
399 Standard_ShortReal myHeight;
400 };
401
402 class Disk : public Quadric
403 {
404 public:
405
406 Disk()
407 : Quadric(),
408 myInnerRad(0.0f),
409 myOuterRad(1.0f)
410 { }
411
412 ~Disk() { }
413
414 void Init (const Standard_ShortReal theInnerRadius,
415 const Standard_ShortReal theOuterRadius,
416 const gp_Ax1& thePosition,
417 const Standard_Integer theSlicesNb = 20,
418 const Standard_Integer theStacksNb = 20);
419
420 protected:
421
422 gp_Ax1 myPosition;
423 Standard_ShortReal myInnerRad;
424 Standard_ShortReal myOuterRad;
425 };
426
427 class Sphere : public Quadric
428 {
429 public:
430 Sphere()
431 : Quadric(),
432 myRadius(1.0f)
433 {}
434
435 void Init (const Standard_ShortReal theRadius,
436 const gp_Pnt& thePosition,
437 const Standard_Integer theSlicesNb = 20,
438 const Standard_Integer theStacksNb = 20);
439
440 protected:
441
442 gp_Pnt myPosition;
443 Standard_ShortReal myRadius;
444 };
445
446 class Cube
447 {
448 public:
449
450 Cube() { }
451 ~Cube() { }
452
453 void Init (const gp_Ax1& thePosition, const Standard_ShortReal myBoxSize);
454
455 const Handle(Poly_Triangulation)& Triangulation() const { return myTriangulation; }
456
457 const Handle(Graphic3d_ArrayOfTriangles)& Array() const { return myArray; }
458
459 private:
460
461 void addTriangle (const Standard_Integer theIndex, const gp_Pnt& theP1, const gp_Pnt& theP2, const gp_Pnt& theP3,
462 const gp_Dir& theNormal);
463
464 protected:
465
466 Handle(Poly_Triangulation) myTriangulation;
467 Handle(Graphic3d_ArrayOfTriangles) myArray;
468 };
469
470 //! The class describes on axis sub-object.
471 //! It includes sub-objects itself:
472 //! -rotator
473 //! -translator
474 //! -scaler
475 class Axis
476 {
477 public:
478
479 Axis (const gp_Ax1& theAxis = gp_Ax1(),
480 const Quantity_Color& theColor = Quantity_Color(),
481 const Standard_ShortReal theLength = 10.0f);
482
483 void Compute (const Handle_PrsMgr_PresentationManager3d& thePrsMgr,
484 const Handle(Prs3d_Presentation)& thePrs,
485 const Handle(Prs3d_ShadingAspect)& theAspect);
486
487 const gp_Ax1& ReferenceAxis() const { return myReferenceAxis; }
488
489 void SetPosition (const gp_Ax1& thePosition) { myPosition = thePosition; }
490
491 const gp_Ax1& Position() const { return myPosition; }
492
778cd667 493 void SetTransformPersistence (const Handle(Graphic3d_TransformPers)& theTrsfPers)
625e1958 494 {
495 if (!myHighlightTranslator.IsNull())
496 {
778cd667 497 myHighlightTranslator->SetTransformPersistence (theTrsfPers);
625e1958 498 }
499
500 if (!myHighlightScaler.IsNull())
501 {
778cd667 502 myHighlightScaler->SetTransformPersistence (theTrsfPers);
625e1958 503 }
504
505 if (!myHighlightRotator.IsNull())
506 {
778cd667 507 myHighlightRotator->SetTransformPersistence (theTrsfPers);
625e1958 508 }
509 }
510
625e1958 511 void Transform (const Handle(Geom_Transformation)& theTransformation)
512 {
513 if (!myHighlightTranslator.IsNull())
514 {
1f7f5a90 515 myHighlightTranslator->SetTransformation (theTransformation);
625e1958 516 }
517
518 if (!myHighlightScaler.IsNull())
519 {
1f7f5a90 520 myHighlightScaler->SetTransformation (theTransformation);
625e1958 521 }
522
523 if (!myHighlightRotator.IsNull())
524 {
1f7f5a90 525 myHighlightRotator->SetTransformation (theTransformation);
625e1958 526 }
527 }
528
529 Standard_Boolean HasTranslation() const { return myHasTranslation; }
530
531 Standard_Boolean HasRotation() const { return myHasRotation; }
532
533 Standard_Boolean HasScaling() const { return myHasScaling; }
534
535 void SetTranslation (const Standard_Boolean theIsEnabled) { myHasTranslation = theIsEnabled; }
536
537 void SetRotation (const Standard_Boolean theIsEnabled) { myHasRotation = theIsEnabled; }
538
539 void SetScaling (const Standard_Boolean theIsEnabled) { myHasScaling = theIsEnabled; }
540
541 Quantity_Color Color() const { return myColor; }
542
543 Standard_ShortReal AxisLength() const { return myLength; }
544
545 Standard_ShortReal AxisRadius() const { return myAxisRadius; }
546
547 void SetAxisRadius (const Standard_ShortReal theValue) { myAxisRadius = theValue; }
548
549 const Handle(Prs3d_Presentation)& TranslatorHighlightPrs() const { return myHighlightTranslator; }
550
551 const Handle(Prs3d_Presentation)& RotatorHighlightPrs() const { return myHighlightRotator; }
552
553 const Handle(Prs3d_Presentation)& ScalerHighlightPrs() const { return myHighlightScaler; }
554
555 const Handle(Graphic3d_Group)& TranslatorGroup() const { return myTranslatorGroup; }
556
557 const Handle(Graphic3d_Group)& RotatorGroup() const { return myRotatorGroup; }
558
559 const Handle(Graphic3d_Group)& ScalerGroup() const { return myScalerGroup; }
560
561 void SetIndent (const Standard_ShortReal theValue) { myIndent = theValue; }
562
563 Standard_ShortReal Size() const { return myLength + myBoxSize + myDiskThickness + myIndent * 2.0f; }
564
565 gp_Pnt ScalerCenter (const gp_Pnt& theLocation) const { return theLocation.XYZ() + myPosition.Direction().XYZ() * (myLength + myIndent + myBoxSize * 0.5f); }
566
567 void SetSize (const Standard_ShortReal theValue)
568 {
569 if (myIndent > theValue * 0.1f)
570 {
571 myLength = theValue * 0.7f;
572 myBoxSize = theValue * 0.15f;
573 myDiskThickness = theValue * 0.05f;
574 myIndent = theValue * 0.05f;
575 }
576 else // use pre-set value of predent
577 {
578 Standard_ShortReal aLength = theValue - 2 * myIndent;
579 myLength = aLength * 0.8f;
580 myBoxSize = aLength * 0.15f;
581 myDiskThickness = aLength * 0.05f;
582 }
583 myInnerRadius = myIndent * 2 + myBoxSize + myLength;
584 myAxisRadius = myBoxSize / 4.0f;
585 }
586
587 Standard_Integer FacettesNumber() const { return myFacettesNumber; }
588
589 public:
590
591 const Cylinder& TranslatorCylinder() const { return myCylinder; }
592 const Cylinder& TranslatorArrow() const { return myArrow; }
593 const gp_Pnt& TranslatorTipPosition() const { return myArrowTipPos; }
594 const Disk& TranslatorArrowBottom() const { return myArrowBottom; }
595 const Disk& RotatorDisk() const { return myCircle; }
596 float RotatorDiskRadius() const { return myCircleRadius; }
597 const Cube& ScalerCube() const { return myCube; }
598 const gp_Pnt& ScalerCubePosition() const { return myCubePos; }
599
600 protected:
601
602 gp_Ax1 myReferenceAxis; //!< Returns reference axis assignment.
603 gp_Ax1 myPosition; //!< Position of the axis including local transformation.
604 Quantity_Color myColor;
605
606 Standard_Boolean myHasTranslation;
607 Standard_ShortReal myLength; //!< Length of translation axis.
608 Standard_ShortReal myAxisRadius;
609
610 Standard_Boolean myHasScaling;
611 Standard_ShortReal myBoxSize; //!< Size of scaling cube.
612
613 Standard_Boolean myHasRotation;
614 Standard_ShortReal myInnerRadius; //!< Radius of rotation circle.
615 Standard_ShortReal myDiskThickness;
616 Standard_ShortReal myIndent; //!< Gap between visual part of the manipulator.
617
618 protected:
619
620 Standard_Integer myFacettesNumber;
621
622 Cylinder myCylinder;
623 Cylinder myArrow;
624 gp_Pnt myArrowTipPos;
625 Disk myArrowBottom;
626 Disk myCircle;
627 float myCircleRadius;
628 Cube myCube;
629 gp_Pnt myCubePos;
630
631 Handle(Graphic3d_Group) myTranslatorGroup;
632 Handle(Graphic3d_Group) myScalerGroup;
633 Handle(Graphic3d_Group) myRotatorGroup;
634
635 Handle(Prs3d_Presentation) myHighlightTranslator;
636 Handle(Prs3d_Presentation) myHighlightScaler;
637 Handle(Prs3d_Presentation) myHighlightRotator;
638 };
639
640protected:
641
642 Axis myAxes[3]; //!< Tree axes of the manipulator.
643 Sphere myCenter; //!< Visual part displaying the center sphere of the manipulator.
644 gp_Ax2 myPosition; //!< Position of the manipualtor object. it displayes its location and position of its axes.
645
646 Standard_Integer myCurrentIndex; //!< Index of active axis.
647 AIS_ManipulatorMode myCurrentMode; //!< Name of active manipualtion mode.
648
649 Standard_Boolean myIsActivationOnDetection; //!< Manual activation of modes (not on parts selection).
650 Standard_Boolean myIsZoomPersistentMode; //!< Zoom persistence mode activation.
651 BehaviorOnTransform myBehaviorOnTransform; //!< Behavior settings applied on manipulator when transforming an object.
652
653protected: //! @name Fields for interactive trnasformation. Fields only for internal needs. They do not have public interface.
654
655 NCollection_Sequence<gp_Trsf> myStartTrsfs; //!< Owning object transformation for start. It is used internally.
656 Standard_Boolean myHasStartedTransformation; //!< Shows if transformation is processed (sequential calls of Transform()).
657 gp_Ax2 myStartPosition; //! Start position of manipulator.
658 gp_Pnt myStartPick; //! 3d point corresponding to start mouse pick.
659 Standard_Real myPrevState; //! Previous value of angle during rotation.
660
661 //! Aspect used to colour current detected part and current selected part.
662 Handle(Prs3d_ShadingAspect) myHighlightAspect;
663public:
664
665 DEFINE_STANDARD_RTTIEXT(AIS_Manipulator, AIS_InteractiveObject)
666};
667#endif // _AIS_Manipulator_HeaderFile