VTK
|
abstract class for representing widget handles More...
#include <vtkHandleRepresentation.h>
Public Types | |
enum | _InteractionState { Outside =0, Nearby, Selecting, Translating, Scaling } |
Public Types inherited from vtkWidgetRepresentation | |
typedef vtkProp | Superclass |
Public Types inherited from vtkProp | |
typedef vtkObject | Superclass |
Public Types inherited from vtkObject | |
typedef vtkObjectBase | Superclass |
Public Member Functions | |
virtual int | CheckConstraint (vtkRenderer *renderer, double pos[2]) |
virtual unsigned long | GetMTime () |
virtual void | SetDisplayPosition (double pos[3]) |
virtual void | GetDisplayPosition (double pos[3]) |
virtual double * | GetDisplayPosition () |
virtual void | SetWorldPosition (double pos[3]) |
virtual void | GetWorldPosition (double pos[3]) |
virtual double * | GetWorldPosition () |
virtual void | SetTolerance (int) |
virtual int | GetTolerance () |
virtual void | SetActiveRepresentation (int) |
virtual int | GetActiveRepresentation () |
virtual void | ActiveRepresentationOn () |
virtual void | ActiveRepresentationOff () |
virtual void | SetInteractionState (int) |
virtual void | SetConstrained (int) |
virtual int | GetConstrained () |
virtual void | ConstrainedOn () |
virtual void | ConstrainedOff () |
virtual void | ShallowCopy (vtkProp *prop) |
virtual void | DeepCopy (vtkProp *prop) |
virtual void | SetRenderer (vtkRenderer *ren) |
virtual void | SetPointPlacer (vtkPointPlacer *) |
virtual vtkPointPlacer * | GetPointPlacer () |
Public Member Functions inherited from vtkWidgetRepresentation | |
virtual void | PickingManagedOn () |
virtual void | PickingManagedOff () |
virtual void | SetPickingManaged (bool) |
virtual bool | GetPickingManaged () |
virtual vtkRenderer * | GetRenderer () |
virtual void | BuildRepresentation ()=0 |
virtual void | PlaceWidget (double *vtkNotUsed(bounds[6])) |
virtual void | StartWidgetInteraction (double eventPos[2]) |
virtual void | WidgetInteraction (double newEventPos[2]) |
virtual void | EndWidgetInteraction (double newEventPos[2]) |
virtual int | ComputeInteractionState (int X, int Y, int modify=0) |
virtual int | GetInteractionState () |
virtual void | Highlight (int vtkNotUsed(highlightOn)) |
virtual void | SetPlaceFactor (double) |
virtual double | GetPlaceFactor () |
virtual void | SetHandleSize (double) |
virtual double | GetHandleSize () |
virtual int | GetNeedToRender () |
virtual void | SetNeedToRender (int) |
virtual void | NeedToRenderOn () |
virtual void | NeedToRenderOff () |
virtual double * | GetBounds () |
virtual void | GetActors (vtkPropCollection *) |
virtual void | GetActors2D (vtkPropCollection *) |
virtual void | GetVolumes (vtkPropCollection *) |
virtual void | ReleaseGraphicsResources (vtkWindow *) |
virtual int | RenderOverlay (vtkViewport *vtkNotUsed(viewport)) |
virtual int | RenderOpaqueGeometry (vtkViewport *vtkNotUsed(viewport)) |
virtual int | RenderTranslucentPolygonalGeometry (vtkViewport *vtkNotUsed(viewport)) |
virtual int | RenderVolumetricGeometry (vtkViewport *vtkNotUsed(viewport)) |
virtual int | HasTranslucentPolygonalGeometry () |
vtkWidgetRepresentation * | NewInstance () const |
void | PrintSelf (ostream &os, vtkIndent indent) |
Public Member Functions inherited from vtkProp | |
vtkProp * | NewInstance () const |
void | PrintSelf (ostream &os, vtkIndent indent) |
virtual void | Pick () |
virtual bool | HasKeys (vtkInformation *requiredKeys) |
virtual void | BuildPaths (vtkAssemblyPaths *paths, vtkAssemblyPath *path) |
virtual void | SetVisibility (int) |
virtual int | GetVisibility () |
virtual void | VisibilityOn () |
virtual void | VisibilityOff () |
virtual void | SetPickable (int) |
virtual int | GetPickable () |
virtual void | PickableOn () |
virtual void | PickableOff () |
virtual void | SetDragable (int) |
virtual int | GetDragable () |
virtual void | DragableOn () |
virtual void | DragableOff () |
virtual unsigned long | GetRedrawMTime () |
virtual void | SetUseBounds (bool) |
virtual bool | GetUseBounds () |
virtual void | UseBoundsOn () |
virtual void | UseBoundsOff () |
virtual void | InitPathTraversal () |
virtual vtkAssemblyPath * | GetNextPath () |
virtual int | GetNumberOfPaths () |
virtual void | PokeMatrix (vtkMatrix4x4 *vtkNotUsed(matrix)) |
virtual vtkMatrix4x4 * | GetMatrix () |
virtual vtkInformation * | GetPropertyKeys () |
virtual void | SetPropertyKeys (vtkInformation *keys) |
virtual int | RenderOpaqueGeometry (vtkViewport *) |
virtual int | RenderTranslucentPolygonalGeometry (vtkViewport *) |
virtual int | RenderVolumetricGeometry (vtkViewport *) |
virtual int | RenderOverlay (vtkViewport *) |
virtual bool | RenderFilteredOpaqueGeometry (vtkViewport *v, vtkInformation *requiredKeys) |
virtual bool | RenderFilteredTranslucentPolygonalGeometry (vtkViewport *v, vtkInformation *requiredKeys) |
virtual bool | RenderFilteredVolumetricGeometry (vtkViewport *v, vtkInformation *requiredKeys) |
virtual bool | RenderFilteredOverlay (vtkViewport *v, vtkInformation *requiredKeys) |
virtual double | GetEstimatedRenderTime (vtkViewport *) |
virtual double | GetEstimatedRenderTime () |
virtual void | SetEstimatedRenderTime (double t) |
virtual void | RestoreEstimatedRenderTime () |
virtual void | AddEstimatedRenderTime (double t, vtkViewport *vtkNotUsed(vp)) |
virtual void | SetAllocatedRenderTime (double t, vtkViewport *vtkNotUsed(v)) |
virtual double | GetAllocatedRenderTime () |
void | SetRenderTimeMultiplier (double t) |
virtual double | GetRenderTimeMultiplier () |
virtual bool | GetSupportsSelection () |
virtual int | GetNumberOfConsumers () |
void | AddConsumer (vtkObject *c) |
void | RemoveConsumer (vtkObject *c) |
vtkObject * | GetConsumer (int i) |
int | IsConsumer (vtkObject *c) |
Public Member Functions inherited from vtkObject | |
vtkObject * | NewInstance () const |
virtual void | DebugOn () |
virtual void | DebugOff () |
bool | GetDebug () |
void | SetDebug (bool debugFlag) |
virtual void | Modified () |
unsigned long | AddObserver (unsigned long event, vtkCommand *, float priority=0.0f) |
unsigned long | AddObserver (const char *event, vtkCommand *, float priority=0.0f) |
vtkCommand * | GetCommand (unsigned long tag) |
void | RemoveObserver (vtkCommand *) |
void | RemoveObservers (unsigned long event, vtkCommand *) |
void | RemoveObservers (const char *event, vtkCommand *) |
int | HasObserver (unsigned long event, vtkCommand *) |
int | HasObserver (const char *event, vtkCommand *) |
void | RemoveObserver (unsigned long tag) |
void | RemoveObservers (unsigned long event) |
void | RemoveObservers (const char *event) |
void | RemoveAllObservers () |
int | HasObserver (unsigned long event) |
int | HasObserver (const char *event) |
template<class U , class T > | |
unsigned long | AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f) |
template<class U , class T > | |
unsigned long | AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f) |
template<class U , class T > | |
unsigned long | AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f) |
int | InvokeEvent (unsigned long event, void *callData) |
int | InvokeEvent (const char *event, void *callData) |
int | InvokeEvent (unsigned long event) |
int | InvokeEvent (const char *event) |
Public Member Functions inherited from vtkObjectBase | |
const char * | GetClassName () const |
virtual void | Delete () |
virtual void | FastDelete () |
void | Print (ostream &os) |
virtual void | Register (vtkObjectBase *o) |
virtual void | UnRegister (vtkObjectBase *o) |
void | SetReferenceCount (int) |
void | PrintRevisions (ostream &) |
virtual void | PrintHeader (ostream &os, vtkIndent indent) |
virtual void | PrintTrailer (ostream &os, vtkIndent indent) |
int | GetReferenceCount () |
Additional Inherited Members | |
Static Public Member Functions inherited from vtkWidgetRepresentation | |
static int | IsTypeOf (const char *type) |
static vtkWidgetRepresentation * | SafeDownCast (vtkObjectBase *o) |
Static Public Member Functions inherited from vtkProp | |
static int | IsTypeOf (const char *type) |
static vtkProp * | SafeDownCast (vtkObjectBase *o) |
static vtkInformationIntegerKey * | GeneralTextureUnit () |
static vtkInformationDoubleVectorKey * | GeneralTextureTransform () |
Static Public Member Functions inherited from vtkObject | |
static int | IsTypeOf (const char *type) |
static vtkObject * | SafeDownCast (vtkObjectBase *o) |
static vtkObject * | New () |
static void | BreakOnError () |
static void | SetGlobalWarningDisplay (int val) |
static void | GlobalWarningDisplayOn () |
static void | GlobalWarningDisplayOff () |
static int | GetGlobalWarningDisplay () |
Static Public Member Functions inherited from vtkObjectBase | |
static int | IsTypeOf (const char *name) |
static vtkObjectBase * | New () |
abstract class for representing widget handles
This class defines an API for widget handle representations. These representations interact with vtkHandleWidget. Various representations can be used depending on the nature of the handle. The basic functionality of the handle representation is to maintain a position. The position is represented via a vtkCoordinate, meaning that the position can be easily obtained in a variety of coordinate systems.
Optional features for this representation include an active mode (the widget appears only when the mouse pointer is close to it). The active distance is expressed in pixels and represents a circle in display space.
The class may be subclassed so that alternative representations can be created. The class defines an API and a default implementation that the vtkHandleWidget interacts with to render itself in the scene.
Definition at line 57 of file vtkHandleRepresentation.h.
Standard methods for instances of this class.
Definition at line 62 of file vtkHandleRepresentation.h.
Enumerator | |
---|---|
Outside | |
Nearby | |
Selecting | |
Translating | |
Scaling |
Definition at line 104 of file vtkHandleRepresentation.h.
|
protected |
|
protected |
|
static |
Standard methods for instances of this class.
|
virtual |
Standard methods for instances of this class.
Reimplemented from vtkWidgetRepresentation.
Reimplemented in vtkConstrainedPointHandleRepresentation, vtkAbstractPolygonalHandleRepresentation3D, vtkPointHandleRepresentation2D, vtkFixedSizeHandleRepresentation3D, vtkSphereHandleRepresentation, vtkPointHandleRepresentation3D, vtkOrientedPolygonalHandleRepresentation3D, and vtkPolygonalHandleRepresentation3D.
|
static |
Standard methods for instances of this class.
|
protectedvirtual |
Standard methods for instances of this class.
Reimplemented from vtkWidgetRepresentation.
Reimplemented in vtkConstrainedPointHandleRepresentation, vtkAbstractPolygonalHandleRepresentation3D, vtkPointHandleRepresentation2D, vtkFixedSizeHandleRepresentation3D, vtkSphereHandleRepresentation, vtkPointHandleRepresentation3D, vtkOrientedPolygonalHandleRepresentation3D, and vtkPolygonalHandleRepresentation3D.
vtkHandleRepresentation* vtkHandleRepresentation::NewInstance | ( | ) | const |
Standard methods for instances of this class.
|
virtual |
Standard methods for instances of this class.
Reimplemented from vtkObject.
Reimplemented in vtkPointHandleRepresentation2D, vtkSphereHandleRepresentation, vtkPointHandleRepresentation3D, vtkOrientedPolygonalHandleRepresentation3D, and vtkPolygonalHandleRepresentation3D.
|
virtual |
Handles usually have their coordinates set in display coordinates (generally by an associated widget) and internally maintain the position in world coordinates. (Using world coordinates insures that handles are rendered in the right position when the camera view changes.) These methods are often subclassed because special constraint operations can be used to control the actual positioning.
Reimplemented in vtkConstrainedPointHandleRepresentation, vtkPointHandleRepresentation2D, vtkAbstractPolygonalHandleRepresentation3D, vtkSphereHandleRepresentation, and vtkPointHandleRepresentation3D.
|
virtual |
Handles usually have their coordinates set in display coordinates (generally by an associated widget) and internally maintain the position in world coordinates. (Using world coordinates insures that handles are rendered in the right position when the camera view changes.) These methods are often subclassed because special constraint operations can be used to control the actual positioning.
|
virtual |
Handles usually have their coordinates set in display coordinates (generally by an associated widget) and internally maintain the position in world coordinates. (Using world coordinates insures that handles are rendered in the right position when the camera view changes.) These methods are often subclassed because special constraint operations can be used to control the actual positioning.
|
virtual |
Handles usually have their coordinates set in display coordinates (generally by an associated widget) and internally maintain the position in world coordinates. (Using world coordinates insures that handles are rendered in the right position when the camera view changes.) These methods are often subclassed because special constraint operations can be used to control the actual positioning.
Reimplemented in vtkAbstractPolygonalHandleRepresentation3D, vtkSphereHandleRepresentation, vtkPointHandleRepresentation3D, and vtkPolygonalHandleRepresentation3D.
|
virtual |
Handles usually have their coordinates set in display coordinates (generally by an associated widget) and internally maintain the position in world coordinates. (Using world coordinates insures that handles are rendered in the right position when the camera view changes.) These methods are often subclassed because special constraint operations can be used to control the actual positioning.
|
virtual |
Handles usually have their coordinates set in display coordinates (generally by an associated widget) and internally maintain the position in world coordinates. (Using world coordinates insures that handles are rendered in the right position when the camera view changes.) These methods are often subclassed because special constraint operations can be used to control the actual positioning.
|
virtual |
The tolerance representing the distance to the widget (in pixels) in which the cursor is considered near enough to the widget to be active.
|
virtual |
The tolerance representing the distance to the widget (in pixels) in which the cursor is considered near enough to the widget to be active.
|
virtual |
Flag controls whether the widget becomes visible when the mouse pointer moves close to it (i.e., the widget becomes active). By default, ActiveRepresentation is off and the representation is always visible.
|
virtual |
Flag controls whether the widget becomes visible when the mouse pointer moves close to it (i.e., the widget becomes active). By default, ActiveRepresentation is off and the representation is always visible.
|
virtual |
Flag controls whether the widget becomes visible when the mouse pointer moves close to it (i.e., the widget becomes active). By default, ActiveRepresentation is off and the representation is always visible.
|
virtual |
Flag controls whether the widget becomes visible when the mouse pointer moves close to it (i.e., the widget becomes active). By default, ActiveRepresentation is off and the representation is always visible.
|
virtual |
The interaction state may be set from a widget (e.g., HandleWidget) or other object. This controls how the interaction with the widget proceeds. Normally this method is used as part of a handshaking processwith the widget: First ComputeInteractionState() is invoked that returns a state based on geometric considerations (i.e., cursor near a widget feature), then based on events, the widget may modify this further.
|
virtual |
Specify whether any motions (such as scale, translate, etc.) are constrained in some way (along an axis, etc.) Widgets can use this to control the resulting motion.
|
virtual |
Specify whether any motions (such as scale, translate, etc.) are constrained in some way (along an axis, etc.) Widgets can use this to control the resulting motion.
|
virtual |
Specify whether any motions (such as scale, translate, etc.) are constrained in some way (along an axis, etc.) Widgets can use this to control the resulting motion.
|
virtual |
Specify whether any motions (such as scale, translate, etc.) are constrained in some way (along an axis, etc.) Widgets can use this to control the resulting motion.
|
virtual |
Method has to be overridden in the subclasses which has constraints on placing the handle (Ex. vtkConstrainedPointHandleRepresentation). It should return 1 if the position is within the constraint, else it should return 0. By default it returns 1.
Reimplemented in vtkConstrainedPointHandleRepresentation.
|
virtual |
Methods to make this class properly act like a vtkWidgetRepresentation.
Reimplemented from vtkWidgetRepresentation.
Reimplemented in vtkConstrainedPointHandleRepresentation, vtkPointHandleRepresentation3D, vtkSphereHandleRepresentation, vtkAbstractPolygonalHandleRepresentation3D, and vtkPointHandleRepresentation2D.
|
virtual |
Methods to make this class properly act like a vtkWidgetRepresentation.
Reimplemented in vtkPointHandleRepresentation3D, vtkSphereHandleRepresentation, vtkAbstractPolygonalHandleRepresentation3D, and vtkPointHandleRepresentation2D.
|
virtual |
Methods to make this class properly act like a vtkWidgetRepresentation.
Reimplemented from vtkWidgetRepresentation.
Reimplemented in vtkConstrainedPointHandleRepresentation.
|
virtual |
Overload the superclasses' GetMTime() because the internal vtkCoordinates are used to keep the state of the representation.
Reimplemented from vtkObject.
|
virtual |
Set/Get the point placer. Point placers can be used to dictate constraints on the placement of handles. As an example, see vtkBoundedPlanePointPlacer (constrains the placement of handles to a set of bounded planes) vtkFocalPlanePointPlacer (constrains placement on the focal plane) etc. The default point placer is vtkPointPlacer (which does not apply any constraints, so the handles are free to move anywhere).
Reimplemented in vtkPointHandleRepresentation2D.
|
virtual |
Set/Get the point placer. Point placers can be used to dictate constraints on the placement of handles. As an example, see vtkBoundedPlanePointPlacer (constrains the placement of handles to a set of bounded planes) vtkFocalPlanePointPlacer (constrains placement on the focal plane) etc. The default point placer is vtkPointPlacer (which does not apply any constraints, so the handles are free to move anywhere).
|
protected |
Definition at line 161 of file vtkHandleRepresentation.h.
|
protected |
Definition at line 162 of file vtkHandleRepresentation.h.
|
protected |
Definition at line 163 of file vtkHandleRepresentation.h.
|
protected |
Definition at line 169 of file vtkHandleRepresentation.h.
|
protected |
Definition at line 170 of file vtkHandleRepresentation.h.
|
protected |
Definition at line 173 of file vtkHandleRepresentation.h.
|
protected |
Definition at line 174 of file vtkHandleRepresentation.h.
|
protected |
Definition at line 177 of file vtkHandleRepresentation.h.