VisualizationFoundation class CATManipulator
Usage: you must use this class as is. You should never derive it.
public class CATManipulator
Class to manipulate representations.
Role:
This object fines the basic mechanisms used to provide direct manipulation
of the visualized objects.
This object should not be instanciated; event thought it is not an abstract object
it should be considered as one.
Constructor and Destructor Index
- o
CATManipulator(CATCommand*,CATString&,CATRep*,CATVizBaseManipulatorMediator*)
-
Constructs the Class.
Method Index
- o
AddRepToManipulate(CATRep*)
- Add a representation to the list of manipulated representations.
- o
AssociateToRep(CATRep*)
- Remove all manipulated representions from the lis of manipulated representations
and add a new one instead.
- o
Destroy()
- Destroy the manipulator, additionnal cleaning is provided
manipulators should always be destroyed this way.
- o
GetCATActivate()
- Get the CATActivate notification's name.
- o
GetCATBeginManipulate()
- Get the CATBeginManipulate notification's name.
- o
GetCATBeginPreDrop()
- Get the CATBeginPreDrop notification's name.
- o
GetCATContext()
- Get the CATContext notification's name .
- o
GetCATDrop()
- Get the CATDrop notification's name.
- o
GetCATEdit()
- Get the CATEdit notification's name.
- o
GetCATEndActivate()
- Get the CATEndActivate notification's name.
- o
GetCATEndContext()
- Get the CATEndContex notification's name.
- o
GetCATEndEdit()
- Get the CATEndEdit notification's name .
- o
GetCATEndManipulate()
- Get the CATEndManipulate notification's name.
- o
GetCATEndPreDrop()
- Get the CATEndPreDrop notification's name.
- o
GetCATEndPreactivate()
- Get the CATEndPreactivate notification's name.
- o
GetCATManipulate()
- Get the CATManipulate notification's name.
- o
GetCATMove()
- Get the CATMove notification's name.
- o
GetCATMoveOver()
- Get the CATMoveOver notification's name.
- o
GetCATPreDrop()
- Get the CATPreDrop notification's name.
- o
GetCATPreactivate()
- Get the CATPreactivate notification's name.
- o
RemoveRepToManipulate(CATRep*)
- Remove a representation to the list of manipulated representations.
- o
SendCommandSpecificObject(char*,CATNotification*)
- Get a desired object provided a notification.
- o
SetFeedbackMode(int)
- Set the feedbacks on.
Data Member Index
- o
PickAllUnder
- A name used to retrieve all CATPathElements on the picking segment used combined with the SendCommandSpecificObject method.
Constructor and Destructor
o CATManipulator
| public CATManipulator( | CATCommand* | iFather, |
| const CATString& | iName, |
| CATRep* | irepresentation | =NULL, |
| CATVizBaseManipulatorMediator* | i_pManipulatorMediator | = NULL) |
-
Constructs the Class.
- Parameters:
-
- iFather
- a pointer to the father command of the manipulator
- iName
- a name for the manipulator
- irepresentation
- a pointer to the manipulated representation
Methods
o AddRepToManipulate
| public void AddRepToManipulate( | CATRep* | ) |
-
Add a representation to the list of manipulated representations.
o AssociateToRep
| public void AssociateToRep( | CATRep* | ) |
-
Remove all manipulated representions from the lis of manipulated representations
and add a new one instead.
o Destroy
-
Destroy the manipulator, additionnal cleaning is provided
manipulators should always be destroyed this way.
o GetCATActivate
| public static const char* GetCATActivate( | ) |
-
Get the CATActivate notification's name.
o GetCATBeginManipulate
| public static const char* GetCATBeginManipulate( | ) |
-
Get the CATBeginManipulate notification's name.
o GetCATBeginPreDrop
| public static const char* GetCATBeginPreDrop( | ) |
-
Get the CATBeginPreDrop notification's name.
o GetCATContext
| public static const char* GetCATContext( | ) |
-
Get the CATContext notification's name .
o GetCATDrop
| public static const char* GetCATDrop( | ) |
-
Get the CATDrop notification's name.
o GetCATEdit
| public static const char* GetCATEdit( | ) |
-
Get the CATEdit notification's name.
o GetCATEndActivate
| public static const char* GetCATEndActivate( | ) |
-
Get the CATEndActivate notification's name.
o GetCATEndContext
| public static const char* GetCATEndContext( | ) |
-
Get the CATEndContex notification's name.
o GetCATEndEdit
| public static const char* GetCATEndEdit( | ) |
-
Get the CATEndEdit notification's name .
o GetCATEndManipulate
| public static const char* GetCATEndManipulate( | ) |
-
Get the CATEndManipulate notification's name.
o GetCATEndPreDrop
| public static const char* GetCATEndPreDrop( | ) |
-
Get the CATEndPreDrop notification's name.
o GetCATEndPreactivate
| public static const char* GetCATEndPreactivate( | ) |
-
Get the CATEndPreactivate notification's name.
o GetCATManipulate
| public static const char* GetCATManipulate( | ) |
-
Get the CATManipulate notification's name.
o GetCATMove
| public static const char* GetCATMove( | ) |
-
Get the CATMove notification's name.
o GetCATMoveOver
| public static const char* GetCATMoveOver( | ) |
-
Get the CATMoveOver notification's name.
o GetCATPreDrop
| public static const char* GetCATPreDrop( | ) |
-
Get the CATPreDrop notification's name.
o GetCATPreactivate
| public static const char* GetCATPreactivate( | ) |
-
Get the CATPreactivate notification's name.
o RemoveRepToManipulate
| public void RemoveRepToManipulate( | CATRep* | ) |
-
Remove a representation to the list of manipulated representations.
o SendCommandSpecificObject
| public virtual void * SendCommandSpecificObject( | const char* | iUuid, |
| CATNotification* | iGraphicNotification) |
-
Get a desired object provided a notification.
- Parameters:
-
- iUuid
- The desired object, given by the ClassName method.
the CATManipulator can return :
CATViewer The viewer from wich the manipulation event originates
CATVisibleElement The CATVisibleElement containing the CATPathElement of all visible elements
CATInsideVisibleElement The CATVisibleElement containing the CATPathElement of all elements entirely visible
CATMouseEvent The CATMouseEvent that spawned the manipulation event
CATIndicationSegment The pincking segment
CATGraphicElementIntersection The point at which the picking segment intersects the manipulated representation
CATGraphicElementNormal The tangent to the manipulated representation if it is a lineic representation, the normal to this representation otherwise
CATSO The CATSO containing all CATPathElements of repesentations under the mouse. Use CATManipulator::PickAllUnder as the iUuid to retrieve it
- iGraphicNotification
- The notification which caused the need for that object
Usually, you ask a command for more information when that
command calls you back. Use pass the notification you receive
in your callback.
o SetFeedbackMode
| public void SetFeedbackMode( | const int | iOnOff | = 1) |
-
Set the feedbacks on.
The feedback is displayed when the user moves the mouse over the representation.
The feedkach is displayed on the intersection point between the mouse and the object.
- Parameters:
-
- OnOff
- Mode On=1 Off=0
Data Members
o PickAllUnder
public static const char* PickAllUnder
-
A name used to retrieve all CATPathElements on the picking segment used combined with the SendCommandSpecificObject method.
This object is included in the file: CATManipulator.h
If needed, your Imakefile.mk should include the module: CATVisFoundation
Copyright © 1999-2015, Dassault Systèmes. All rights reserved.