VTK
|
abstract class defines interface between the widget and widget representation classes More...
#include <vtkWidgetRepresentation.h>
Public Types | |
typedef vtkProp | Superclass |
Standard methods for instances of this class. More... | |
![]() | |
typedef vtkObject | Superclass |
Public Member Functions | |
virtual int | IsA (const char *type) |
Return 1 if this class is the same type of (or a subclass of) the named class. More... | |
vtkWidgetRepresentation * | NewInstance () const |
void | PrintSelf (ostream &os, vtkIndent indent) |
Methods invoked by print to print information about the object including superclasses. More... | |
virtual void | PickingManagedOn () |
Enable/Disable the use of a manager to process the picking. More... | |
virtual void | PickingManagedOff () |
virtual void | SetPickingManaged (bool) |
virtual bool | GetPickingManaged () |
virtual void | SetRenderer (vtkRenderer *ren) |
Subclasses of vtkWidgetRepresentation must implement these methods. More... | |
virtual vtkRenderer * | GetRenderer () |
virtual void | BuildRepresentation ()=0 |
virtual void | PlaceWidget (double *vtkNotUsed(bounds[6])) |
The following is a suggested API for widget representations. More... | |
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) |
Set/Get a factor representing the scaling of the widget upon placement (via the PlaceWidget() method). More... | |
virtual double | GetPlaceFactor () |
virtual void | SetHandleSize (double) |
Set/Get the factor that controls the size of the handles that appear as part of the widget (if any). More... | |
virtual double | GetHandleSize () |
virtual int | GetNeedToRender () |
Some subclasses use this data member to keep track of whether to render or not (i.e., to minimize the total number of renders). More... | |
virtual void | SetNeedToRender (int) |
virtual void | NeedToRenderOn () |
virtual void | NeedToRenderOff () |
virtual double * | GetBounds () |
Methods to make this class behave as a vtkProp. More... | |
virtual void | ShallowCopy (vtkProp *prop) |
Shallow copy of this vtkProp. More... | |
virtual void | GetActors (vtkPropCollection *) |
For some exporters and other other operations we must be able to collect all the actors or volumes. More... | |
virtual void | GetActors2D (vtkPropCollection *) |
virtual void | GetVolumes (vtkPropCollection *) |
virtual void | ReleaseGraphicsResources (vtkWindow *) |
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Release any graphics resources that are being consumed by this actor. More... | |
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 () |
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS Does this prop have some translucent polygonal geometry? This method is called during the rendering process to know if there is some translucent polygonal geometry. More... | |
![]() | |
virtual int | IsA (const char *type) |
Return 1 if this class is the same type of (or a subclass of) the named class. More... | |
vtkProp * | NewInstance () const |
void | PrintSelf (ostream &os, vtkIndent indent) |
Methods invoked by print to print information about the object including superclasses. More... | |
virtual void | GetActors (vtkPropCollection *) |
For some exporters and other other operations we must be able to collect all the actors or volumes. More... | |
virtual void | GetActors2D (vtkPropCollection *) |
virtual void | GetVolumes (vtkPropCollection *) |
virtual void | SetVisibility (int) |
Set/Get visibility of this vtkProp. More... | |
virtual int | GetVisibility () |
virtual void | VisibilityOn () |
virtual void | VisibilityOff () |
virtual void | SetPickable (int) |
Set/Get the pickable instance variable. More... | |
virtual int | GetPickable () |
virtual void | PickableOn () |
virtual void | PickableOff () |
virtual void | Pick () |
Method fires PickEvent if the prop is picked. More... | |
virtual void | SetDragable (int) |
Set/Get the value of the dragable instance variable. More... | |
virtual int | GetDragable () |
virtual void | DragableOn () |
virtual void | DragableOff () |
virtual vtkMTimeType | GetRedrawMTime () |
Return the mtime of anything that would cause the rendered image to appear differently. More... | |
virtual void | SetUseBounds (bool) |
In case the Visibility flag is true, tell if the bounds of this prop should be taken into account or ignored during the computation of other bounding boxes, like in vtkRenderer::ResetCamera(). More... | |
virtual bool | GetUseBounds () |
virtual void | UseBoundsOn () |
virtual void | UseBoundsOff () |
virtual double * | GetBounds () |
Get the bounds for this Prop as (Xmin,Xmax,Ymin,Ymax,Zmin,Zmax). More... | |
virtual void | ShallowCopy (vtkProp *prop) |
Shallow copy of this vtkProp. More... | |
virtual void | InitPathTraversal () |
vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g., vtkPropPicker). More... | |
virtual vtkAssemblyPath * | GetNextPath () |
virtual int | GetNumberOfPaths () |
virtual void | PokeMatrix (vtkMatrix4x4 *vtkNotUsed(matrix)) |
These methods are used by subclasses to place a matrix (if any) in the prop prior to rendering. More... | |
virtual vtkMatrix4x4 * | GetMatrix () |
virtual vtkInformation * | GetPropertyKeys () |
Set/Get property keys. More... | |
virtual void | SetPropertyKeys (vtkInformation *keys) |
virtual bool | HasKeys (vtkInformation *requiredKeys) |
Tells if the prop has all the required keys. More... | |
virtual int | RenderOpaqueGeometry (vtkViewport *) |
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS All concrete subclasses must be able to render themselves. More... | |
virtual int | RenderTranslucentPolygonalGeometry (vtkViewport *) |
virtual int | RenderVolumetricGeometry (vtkViewport *) |
virtual int | RenderOverlay (vtkViewport *) |
virtual bool | RenderFilteredOpaqueGeometry (vtkViewport *v, vtkInformation *requiredKeys) |
Render the opaque geometry only if the prop has all the requiredKeys. More... | |
virtual bool | RenderFilteredTranslucentPolygonalGeometry (vtkViewport *v, vtkInformation *requiredKeys) |
Render the translucent polygonal geometry only if the prop has all the requiredKeys. More... | |
virtual bool | RenderFilteredVolumetricGeometry (vtkViewport *v, vtkInformation *requiredKeys) |
Render the volumetric geometry only if the prop has all the requiredKeys. More... | |
virtual bool | RenderFilteredOverlay (vtkViewport *v, vtkInformation *requiredKeys) |
Render in the overlay of the viewport only if the prop has all the requiredKeys. More... | |
virtual int | HasTranslucentPolygonalGeometry () |
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS Does this prop have some translucent polygonal geometry? This method is called during the rendering process to know if there is some translucent polygonal geometry. More... | |
virtual void | ReleaseGraphicsResources (vtkWindow *) |
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Release any graphics resources that are being consumed by this actor. More... | |
virtual double | GetEstimatedRenderTime (vtkViewport *) |
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS The EstimatedRenderTime may be used to select between different props, for example in LODProp it is used to select the level-of-detail. More... | |
virtual double | GetEstimatedRenderTime () |
virtual void | SetEstimatedRenderTime (double t) |
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS This method is used by, for example, the vtkLODProp3D in order to initialize the estimated render time at start-up to some user defined value. More... | |
virtual void | RestoreEstimatedRenderTime () |
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS When the EstimatedRenderTime is first set to 0.0 (in the SetAllocatedRenderTime method) the old value is saved. More... | |
virtual void | AddEstimatedRenderTime (double t, vtkViewport *vtkNotUsed(vp)) |
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS This method is intended to allow the renderer to add to the EstimatedRenderTime in props that require information that the renderer has in order to do this. More... | |
virtual void | SetAllocatedRenderTime (double t, vtkViewport *vtkNotUsed(v)) |
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS The renderer may use the allocated rendering time to determine how to render this actor. More... | |
virtual double | GetAllocatedRenderTime () |
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS. More... | |
void | SetRenderTimeMultiplier (double t) |
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Get/Set the multiplier for the render time. More... | |
virtual double | GetRenderTimeMultiplier () |
virtual void | BuildPaths (vtkAssemblyPaths *paths, vtkAssemblyPath *path) |
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Used to construct assembly paths and perform part traversal. More... | |
virtual bool | GetSupportsSelection () |
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Used by vtkHardwareSelector to determine if the prop supports hardware selection. More... | |
virtual int | GetNumberOfConsumers () |
Get the number of consumers. More... | |
void | AddConsumer (vtkObject *c) |
Add or remove or get or check a consumer,. More... | |
void | RemoveConsumer (vtkObject *c) |
vtkObject * | GetConsumer (int i) |
int | IsConsumer (vtkObject *c) |
![]() | |
vtkBaseTypeMacro (vtkObject, vtkObjectBase) | |
virtual void | DebugOn () |
Turn debugging output on. More... | |
virtual void | DebugOff () |
Turn debugging output off. More... | |
bool | GetDebug () |
Get the value of the debug flag. More... | |
void | SetDebug (bool debugFlag) |
Set the value of the debug flag. More... | |
virtual void | Modified () |
Update the modification time for this object. More... | |
virtual vtkMTimeType | GetMTime () |
Return this object's modified time. More... | |
void | PrintSelf (ostream &os, vtkIndent indent) override |
Methods invoked by print to print information about the object including superclasses. More... | |
unsigned long | AddObserver (unsigned long event, vtkCommand *, float priority=0.0f) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
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) |
Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More... | |
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) |
Allow user to set the AbortFlagOn() with the return value of the callback method. More... | |
int | InvokeEvent (unsigned long event, void *callData) |
This method invokes an event and return whether the event was aborted or not. More... | |
int | InvokeEvent (const char *event, void *callData) |
int | InvokeEvent (unsigned long event) |
int | InvokeEvent (const char *event) |
![]() | |
const char * | GetClassName () const |
Return the class name as a string. More... | |
virtual vtkTypeBool | IsA (const char *name) |
Return 1 if this class is the same type of (or a subclass of) the named class. More... | |
virtual void | Delete () |
Delete a VTK object. More... | |
virtual void | FastDelete () |
Delete a reference to this object. More... | |
void | InitializeObjectBase () |
void | Print (ostream &os) |
Print an object to an ostream. More... | |
virtual void | PrintSelf (ostream &os, vtkIndent indent) |
Methods invoked by print to print information about the object including superclasses. More... | |
virtual void | PrintHeader (ostream &os, vtkIndent indent) |
virtual void | PrintTrailer (ostream &os, vtkIndent indent) |
virtual void | Register (vtkObjectBase *o) |
Increase the reference count (mark as used by another object). More... | |
virtual void | UnRegister (vtkObjectBase *o) |
Decrease the reference count (release by another object). More... | |
int | GetReferenceCount () |
Return the current reference count of this object. More... | |
void | SetReferenceCount (int) |
Sets the reference count. More... | |
void | PrintRevisions (ostream &) |
Legacy. More... | |
Static Public Member Functions | |
static int | IsTypeOf (const char *type) |
static vtkWidgetRepresentation * | SafeDownCast (vtkObjectBase *o) |
![]() | |
static int | IsTypeOf (const char *type) |
static vtkProp * | SafeDownCast (vtkObjectBase *o) |
static vtkInformationIntegerKey * | GeneralTextureUnit () |
Optional Key Indicating the texture unit for general texture mapping Old OpenGL was a state machine where you would push or pop items. More... | |
static vtkInformationDoubleVectorKey * | GeneralTextureTransform () |
Optional Key Indicating the texture transform for general texture mapping Old OpenGL was a state machine where you would push or pop items. More... | |
![]() | |
static vtkObject * | New () |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More... | |
static void | BreakOnError () |
This method is called when vtkErrorMacro executes. More... | |
static void | SetGlobalWarningDisplay (int val) |
This is a global flag that controls whether any debug, warning or error messages are displayed. More... | |
static void | GlobalWarningDisplayOn () |
static void | GlobalWarningDisplayOff () |
static int | GetGlobalWarningDisplay () |
![]() | |
static vtkTypeBool | IsTypeOf (const char *name) |
Return 1 if this class type is the same type of (or a subclass of) the named class. More... | |
static vtkObjectBase * | New () |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More... | |
Protected Member Functions | |
virtual vtkObjectBase * | NewInstanceInternal () const |
vtkWidgetRepresentation () | |
~vtkWidgetRepresentation () | |
void | AdjustBounds (double bounds[6], double newBounds[6], double center[3]) |
virtual void | RegisterPickers () |
Register internal Pickers in the Picking Manager. More... | |
virtual void | UnRegisterPickers () |
Unregister internal pickers from the Picking Manager. More... | |
virtual void | PickersModified () |
Update the pickers registered in the Picking Manager when pickers are modified. More... | |
vtkPickingManager * | GetPickingManager () |
Return the picking manager associated on the context on which the widget representation currently belong. More... | |
vtkAssemblyPath * | GetAssemblyPath (double X, double Y, double Z, vtkAbstractPropPicker *picker) |
Proceed to a pick, whether through the PickingManager if the picking is managed or directly using the registered picker, and return the assembly path. More... | |
double | SizeHandlesRelativeToViewport (double factor, double pos[3]) |
double | SizeHandlesInPixels (double factor, double pos[3]) |
![]() | |
virtual vtkObjectBase * | NewInstanceInternal () const |
vtkProp () | |
~vtkProp () | |
![]() | |
vtkObject () | |
~vtkObject () override | |
void | RegisterInternal (vtkObjectBase *, vtkTypeBool check) override |
void | UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override |
void | InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL) |
These methods allow a command to exclusively grab all events. More... | |
void | InternalReleaseFocus () |
![]() | |
vtkObjectBase () | |
virtual | ~vtkObjectBase () |
virtual void | CollectRevisions (ostream &) |
virtual void | RegisterInternal (vtkObjectBase *, vtkTypeBool check) |
virtual void | UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) |
virtual void | ReportReferences (vtkGarbageCollector *) |
vtkObjectBase (const vtkObjectBase &) | |
void | operator= (const vtkObjectBase &) |
Protected Attributes | |
vtkWeakPointer< vtkRenderer > | Renderer |
int | InteractionState |
double | StartEventPosition [3] |
double | PlaceFactor |
int | Placed |
double | InitialBounds [6] |
double | InitialLength |
int | ValidPick |
bool | PickingManaged |
double | HandleSize |
int | NeedToRender |
vtkTimeStamp | BuildTime |
![]() | |
int | Visibility |
int | Pickable |
int | Dragable |
bool | UseBounds |
double | AllocatedRenderTime |
double | EstimatedRenderTime |
double | SavedEstimatedRenderTime |
double | RenderTimeMultiplier |
int | NumberOfConsumers |
vtkObject ** | Consumers |
vtkAssemblyPaths * | Paths |
vtkInformation * | PropertyKeys |
![]() | |
bool | Debug |
vtkTimeStamp | MTime |
vtkSubjectHelper * | SubjectHelper |
![]() | |
vtkAtomicInt32 | ReferenceCount |
vtkWeakPointerBase ** | WeakPointers |
abstract class defines interface between the widget and widget representation classes
This class is used to define the API for, and partially implement, a representation for different types of widgets. Note that the widget representation (i.e., subclasses of vtkWidgetRepresentation) are a type of vtkProp; meaning that they can be associated with a vtkRenderer end embedded in a scene like any other vtkActor. However, vtkWidgetRepresentation also defines an API that enables it to be paired with a subclass vtkAbstractWidget, meaning that it can be driven by a widget, serving to represent the widget as the widget responds to registered events.
The API defined here should be regarded as a guideline for implementing widgets and widget representations. Widget behavior is complex, as is the way the representation responds to the registered widget events, so the API may vary from widget to widget to reflect this complexity.
Definition at line 54 of file vtkWidgetRepresentation.h.
Standard methods for instances of this class.
Definition at line 61 of file vtkWidgetRepresentation.h.
|
protected |
|
protected |
|
static |
|
virtual |
Return 1 if this class is the same type of (or a subclass of) the named class.
Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.
Reimplemented from vtkProp.
Reimplemented in vtkCompassRepresentation, vtkAbstractPolygonalHandleRepresentation3D, vtkAffineRepresentation, vtkAffineRepresentation2D, vtkAngleRepresentation, vtkAngleRepresentation2D, vtkAngleRepresentation3D, vtkAxesTransformRepresentation, vtkBalloonRepresentation, vtkBiDimensionalRepresentation, vtkBiDimensionalRepresentation2D, vtkBorderRepresentation, vtkBoxRepresentation, vtkButtonRepresentation, vtkCameraRepresentation, vtkCaptionRepresentation, vtkCenteredSliderRepresentation, vtkCheckerboardRepresentation, vtkConstrainedPointHandleRepresentation, vtkContinuousValueWidgetRepresentation, vtkContourRepresentation, vtkCurveRepresentation, vtkDistanceRepresentation, vtkDistanceRepresentation2D, vtkDistanceRepresentation3D, vtkEllipsoidTensorProbeRepresentation, vtkFinitePlaneRepresentation, vtkFixedSizeHandleRepresentation3D, vtkFocalPlaneContourRepresentation, vtkHandleRepresentation, vtkImplicitCylinderRepresentation, vtkImplicitPlaneRepresentation, vtkLineRepresentation, vtkLogoRepresentation, vtkOrientedGlyphContourRepresentation, vtkOrientedGlyphFocalPlaneContourRepresentation, vtkOrientedPolygonalHandleRepresentation3D, vtkParallelopipedRepresentation, vtkPlaybackRepresentation, vtkPointHandleRepresentation2D, vtkPointHandleRepresentation3D, vtkPolygonalHandleRepresentation3D, vtkPolyLineRepresentation, vtkProgressBarRepresentation, vtkProp3DButtonRepresentation, vtkRectilinearWipeRepresentation, vtkResliceCursorLineRepresentation, vtkResliceCursorRepresentation, vtkResliceCursorThickLineRepresentation, vtkScalarBarRepresentation, vtkSeedRepresentation, vtkSliderRepresentation, vtkSliderRepresentation2D, vtkSliderRepresentation3D, vtkSphereHandleRepresentation, vtkSphereRepresentation, vtkSplineRepresentation, vtkTensorProbeRepresentation, vtkTextRepresentation, vtkTexturedButtonRepresentation, vtkTexturedButtonRepresentation2D, and vtkXYPlotRepresentation.
|
static |
|
protectedvirtual |
Reimplemented from vtkProp.
Reimplemented in vtkCompassRepresentation, vtkAbstractPolygonalHandleRepresentation3D, vtkAffineRepresentation, vtkAffineRepresentation2D, vtkAngleRepresentation, vtkAngleRepresentation2D, vtkAngleRepresentation3D, vtkAxesTransformRepresentation, vtkBalloonRepresentation, vtkBiDimensionalRepresentation, vtkBiDimensionalRepresentation2D, vtkBorderRepresentation, vtkBoxRepresentation, vtkButtonRepresentation, vtkCameraRepresentation, vtkCaptionRepresentation, vtkCenteredSliderRepresentation, vtkCheckerboardRepresentation, vtkConstrainedPointHandleRepresentation, vtkContinuousValueWidgetRepresentation, vtkContourRepresentation, vtkCurveRepresentation, vtkDistanceRepresentation, vtkDistanceRepresentation2D, vtkDistanceRepresentation3D, vtkEllipsoidTensorProbeRepresentation, vtkFinitePlaneRepresentation, vtkFixedSizeHandleRepresentation3D, vtkFocalPlaneContourRepresentation, vtkHandleRepresentation, vtkImplicitCylinderRepresentation, vtkImplicitPlaneRepresentation, vtkLineRepresentation, vtkLogoRepresentation, vtkOrientedGlyphContourRepresentation, vtkOrientedGlyphFocalPlaneContourRepresentation, vtkOrientedPolygonalHandleRepresentation3D, vtkParallelopipedRepresentation, vtkPlaybackRepresentation, vtkPointHandleRepresentation2D, vtkPointHandleRepresentation3D, vtkPolygonalHandleRepresentation3D, vtkPolyLineRepresentation, vtkProgressBarRepresentation, vtkProp3DButtonRepresentation, vtkRectilinearWipeRepresentation, vtkResliceCursorLineRepresentation, vtkResliceCursorRepresentation, vtkResliceCursorThickLineRepresentation, vtkScalarBarRepresentation, vtkSeedRepresentation, vtkSliderRepresentation, vtkSliderRepresentation2D, vtkSliderRepresentation3D, vtkSphereHandleRepresentation, vtkSphereRepresentation, vtkSplineRepresentation, vtkTensorProbeRepresentation, vtkTextRepresentation, vtkTexturedButtonRepresentation, vtkTexturedButtonRepresentation2D, and vtkXYPlotRepresentation.
vtkWidgetRepresentation * vtkWidgetRepresentation::NewInstance | ( | ) | const |
|
virtual |
Methods invoked by print to print information about the object including superclasses.
Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.
Reimplemented from vtkObject.
Reimplemented in vtkXYPlotRepresentation.
|
virtual |
Enable/Disable the use of a manager to process the picking.
Enabled by default.
|
virtual |
|
virtual |
|
virtual |
|
virtual |
Subclasses of vtkWidgetRepresentation must implement these methods.
This is considered the minimum API for a widget representation.
SetRenderer() - the renderer in which the representations draws itself. Typically the renderer is set by the associated widget. Use the widget's SetCurrentRenderer() method in most cases; otherwise there is a risk of inconsistent behavior as events and drawing may be performed in different viewports. BuildRepresentation() - update the geometry of the widget based on its current state.
WARNING: The renderer is NOT reference counted by the representation, in order to avoid reference loops. Be sure that the representation lifetime does not extend beyond the renderer lifetime.
Reimplemented in vtkCompassRepresentation, vtkConstrainedPointHandleRepresentation, vtkHandleRepresentation, vtkLineRepresentation, vtkOrientedGlyphContourRepresentation, and vtkOrientedGlyphFocalPlaneContourRepresentation.
|
virtual |
|
pure virtual |
Implemented in vtkCompassRepresentation, vtkAbstractPolygonalHandleRepresentation3D, vtkAffineRepresentation2D, vtkAngleRepresentation, vtkAngleRepresentation2D, vtkAngleRepresentation3D, vtkAxesTransformRepresentation, vtkBalloonRepresentation, vtkBiDimensionalRepresentation2D, vtkBorderRepresentation, vtkBoxRepresentation, vtkCameraRepresentation, vtkCaptionRepresentation, vtkCenteredSliderRepresentation, vtkCheckerboardRepresentation, vtkConstrainedPointHandleRepresentation, vtkContinuousValueWidgetRepresentation, vtkDistanceRepresentation, vtkDistanceRepresentation2D, vtkDistanceRepresentation3D, vtkEllipsoidTensorProbeRepresentation, vtkFinitePlaneRepresentation, vtkFixedSizeHandleRepresentation3D, vtkImplicitCylinderRepresentation, vtkImplicitPlaneRepresentation, vtkLineRepresentation, vtkLogoRepresentation, vtkOrientedGlyphContourRepresentation, vtkOrientedGlyphFocalPlaneContourRepresentation, vtkParallelopipedRepresentation, vtkPlaybackRepresentation, vtkPointHandleRepresentation2D, vtkPointHandleRepresentation3D, vtkPolyLineRepresentation, vtkProgressBarRepresentation, vtkProp3DButtonRepresentation, vtkRectilinearWipeRepresentation, vtkResliceCursorLineRepresentation, vtkResliceCursorRepresentation, vtkScalarBarRepresentation, vtkSeedRepresentation, vtkSliderRepresentation2D, vtkSliderRepresentation3D, vtkSphereHandleRepresentation, vtkSphereRepresentation, vtkSplineRepresentation, vtkTensorProbeRepresentation, vtkTextRepresentation, vtkTexturedButtonRepresentation, vtkTexturedButtonRepresentation2D, vtkXYPlotRepresentation, vtkContourRepresentation, and vtkCurveRepresentation.
|
inlinevirtual |
The following is a suggested API for widget representations.
These methods define the communication between the widget and its representation. These methods are only suggestions because widgets take on so many different forms that a universal API is not deemed practical. However, these methods should be implemented when possible to insure that the VTK widget hierarchy remains self-consistent.
PlaceWidget() - given a bounding box (xmin,xmax,ymin,ymax,zmin,zmax), place the widget inside of it. The current orientation of the widget is preserved, only scaling and translation is performed. StartWidgetInteraction() - generally corresponds to a initial event (e.g., mouse down) that starts the interaction process with the widget. WidgetInteraction() - invoked when an event causes the widget to change appearance. EndWidgetInteraction() - generally corresponds to a final event (e.g., mouse up) and completes the interaction sequence. ComputeInteractionState() - given (X,Y) display coordinates in a renderer, with a possible flag that modifies the computation, what is the state of the widget? GetInteractionState() - return the current state of the widget. Note that the value of "0" typically refers to "outside". The interaction state is strictly a function of the representation, and the widget/represent must agree on what they mean. Highlight() - turn on or off any highlights associated with the widget. Highlights are generally turned on when the widget is selected.
Note that subclasses may ignore some of these methods and implement their own depending on the specifics of the widget.
Definition at line 129 of file vtkWidgetRepresentation.h.
|
inlinevirtual |
Reimplemented in vtkAngleRepresentation, vtkAxesTransformRepresentation, vtkBalloonRepresentation, vtkBoxRepresentation, vtkCurveRepresentation, vtkDistanceRepresentation, vtkFinitePlaneRepresentation, vtkLineRepresentation, vtkSphereRepresentation, vtkContourRepresentation, vtkCompassRepresentation, vtkAbstractPolygonalHandleRepresentation3D, vtkAffineRepresentation2D, vtkBorderRepresentation, vtkCenteredSliderRepresentation, vtkConstrainedPointHandleRepresentation, vtkImplicitCylinderRepresentation, vtkImplicitPlaneRepresentation, vtkOrientedGlyphContourRepresentation, vtkOrientedGlyphFocalPlaneContourRepresentation, vtkPointHandleRepresentation2D, vtkPointHandleRepresentation3D, vtkRectilinearWipeRepresentation, vtkSliderRepresentation2D, vtkSliderRepresentation3D, vtkSphereHandleRepresentation, vtkContinuousValueWidgetRepresentation, and vtkResliceCursorLineRepresentation.
Definition at line 130 of file vtkWidgetRepresentation.h.
|
inlinevirtual |
Reimplemented in vtkAngleRepresentation, vtkAxesTransformRepresentation, vtkBiDimensionalRepresentation2D, vtkBoxRepresentation, vtkCurveRepresentation, vtkDistanceRepresentation, vtkFinitePlaneRepresentation, vtkLineRepresentation, vtkResliceCursorLineRepresentation, vtkSphereRepresentation, vtkContourRepresentation, vtkCompassRepresentation, vtkAbstractPolygonalHandleRepresentation3D, vtkAffineRepresentation2D, vtkBorderRepresentation, vtkCenteredSliderRepresentation, vtkConstrainedPointHandleRepresentation, vtkOrientedGlyphContourRepresentation, vtkOrientedGlyphFocalPlaneContourRepresentation, vtkPointHandleRepresentation2D, vtkPointHandleRepresentation3D, vtkRectilinearWipeRepresentation, vtkScalarBarRepresentation, vtkSphereHandleRepresentation, vtkXYPlotRepresentation, vtkContinuousValueWidgetRepresentation, vtkImplicitCylinderRepresentation, vtkImplicitPlaneRepresentation, vtkSliderRepresentation2D, and vtkSliderRepresentation3D.
Definition at line 131 of file vtkWidgetRepresentation.h.
|
inlinevirtual |
Reimplemented in vtkBalloonRepresentation, vtkCurveRepresentation, vtkAffineRepresentation2D, vtkImplicitCylinderRepresentation, and vtkImplicitPlaneRepresentation.
Definition at line 132 of file vtkWidgetRepresentation.h.
|
virtual |
Reimplemented in vtkOrientedGlyphContourRepresentation, vtkOrientedGlyphFocalPlaneContourRepresentation, vtkContourRepresentation, vtkConstrainedPointHandleRepresentation, vtkCompassRepresentation, vtkAbstractPolygonalHandleRepresentation3D, vtkAffineRepresentation2D, vtkAngleRepresentation, vtkAxesTransformRepresentation, vtkBalloonRepresentation, vtkBiDimensionalRepresentation2D, vtkBorderRepresentation, vtkBoxRepresentation, vtkCenteredSliderRepresentation, vtkCurveRepresentation, vtkDistanceRepresentation, vtkFinitePlaneRepresentation, vtkImplicitCylinderRepresentation, vtkImplicitPlaneRepresentation, vtkLineRepresentation, vtkParallelopipedRepresentation, vtkPointHandleRepresentation2D, vtkPointHandleRepresentation3D, vtkProp3DButtonRepresentation, vtkRectilinearWipeRepresentation, vtkResliceCursorLineRepresentation, vtkSeedRepresentation, vtkSphereHandleRepresentation, vtkSphereRepresentation, vtkTexturedButtonRepresentation, and vtkTexturedButtonRepresentation2D.
|
inlinevirtual |
Definition at line 134 of file vtkWidgetRepresentation.h.
|
inlinevirtual |
Definition at line 136 of file vtkWidgetRepresentation.h.
|
virtual |
Set/Get a factor representing the scaling of the widget upon placement (via the PlaceWidget() method).
Normally the widget is placed so that it just fits within the bounding box defined in PlaceWidget(bounds). The PlaceFactor will make the widget larger (PlaceFactor > 1) or smaller (PlaceFactor < 1). By default, PlaceFactor is set to 0.5.
|
virtual |
|
virtual |
Set/Get the factor that controls the size of the handles that appear as part of the widget (if any).
These handles (like spheres, etc.) are used to manipulate the widget. The HandleSize data member allows you to change the relative size of the handles. Note that while the handle size is typically expressed in pixels, some subclasses may use a relative size with respect to the viewport. (As a corollary, the value of this ivar is often set by subclasses of this class during instance instantiation.)
Reimplemented in vtkPointHandleRepresentation3D, and vtkSphereHandleRepresentation.
|
virtual |
|
virtual |
Some subclasses use this data member to keep track of whether to render or not (i.e., to minimize the total number of renders).
|
virtual |
|
virtual |
|
virtual |
|
inlinevirtual |
Methods to make this class behave as a vtkProp.
They are repeated here (from the vtkProp superclass) as a reminder to the widget implementor. Failure to implement these methods properly may result in the representation not appearing in the scene (i.e., not implementing the Render() methods properly) or leaking graphics resources (i.e., not implementing ReleaseGraphicsResources() properly).
Reimplemented from vtkProp.
Reimplemented in vtkAbstractPolygonalHandleRepresentation3D, vtkAxesTransformRepresentation, vtkBoxRepresentation, vtkCurveRepresentation, vtkDistanceRepresentation3D, vtkFinitePlaneRepresentation, vtkImplicitCylinderRepresentation, vtkImplicitPlaneRepresentation, vtkLineRepresentation, vtkOrientedGlyphContourRepresentation, vtkParallelopipedRepresentation, vtkPointHandleRepresentation2D, vtkPointHandleRepresentation3D, vtkProp3DButtonRepresentation, vtkResliceCursorLineRepresentation, vtkSliderRepresentation3D, vtkSphereHandleRepresentation, vtkSphereRepresentation, vtkTexturedButtonRepresentation, and vtkTexturedButtonRepresentation2D.
Definition at line 181 of file vtkWidgetRepresentation.h.
|
virtual |
Shallow copy of this vtkProp.
Reimplemented from vtkProp.
Reimplemented in vtkAbstractPolygonalHandleRepresentation3D, vtkAffineRepresentation, vtkAffineRepresentation2D, vtkButtonRepresentation, vtkConstrainedPointHandleRepresentation, vtkHandleRepresentation, vtkPointHandleRepresentation2D, vtkPointHandleRepresentation3D, vtkProp3DButtonRepresentation, vtkSphereHandleRepresentation, vtkTexturedButtonRepresentation, and vtkTexturedButtonRepresentation2D.
|
inlinevirtual |
For some exporters and other other operations we must be able to collect all the actors or volumes.
These methods are used in that process.
Reimplemented from vtkProp.
Reimplemented in vtkCompassRepresentation, vtkAbstractPolygonalHandleRepresentation3D, vtkCenteredSliderRepresentation, vtkCheckerboardRepresentation, vtkConstrainedPointHandleRepresentation, vtkEllipsoidTensorProbeRepresentation, vtkOrientedGlyphContourRepresentation, vtkPointHandleRepresentation3D, vtkSliderRepresentation3D, vtkSphereHandleRepresentation, vtkTensorProbeRepresentation, vtkImplicitCylinderRepresentation, vtkImplicitPlaneRepresentation, vtkLineRepresentation, vtkParallelopipedRepresentation, vtkProp3DButtonRepresentation, vtkTexturedButtonRepresentation, and vtkTexturedButtonRepresentation2D.
Definition at line 183 of file vtkWidgetRepresentation.h.
|
inlinevirtual |
Reimplemented from vtkProp.
Reimplemented in vtkAffineRepresentation2D, vtkBorderRepresentation, vtkCameraRepresentation, vtkCaptionRepresentation, vtkOrientedGlyphFocalPlaneContourRepresentation, vtkPlaybackRepresentation, vtkPointHandleRepresentation2D, vtkProgressBarRepresentation, vtkRectilinearWipeRepresentation, vtkSliderRepresentation2D, vtkTextRepresentation, vtkScalarBarRepresentation, vtkXYPlotRepresentation, and vtkLogoRepresentation.
Definition at line 184 of file vtkWidgetRepresentation.h.
|
inlinevirtual |
Reimplemented from vtkProp.
Definition at line 185 of file vtkWidgetRepresentation.h.
|
inlinevirtual |
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Release any graphics resources that are being consumed by this actor.
The parameter window could be used to determine which graphic resources to release.
Reimplemented from vtkProp.
Reimplemented in vtkCompassRepresentation, vtkAbstractPolygonalHandleRepresentation3D, vtkAffineRepresentation2D, vtkBorderRepresentation, vtkBoxRepresentation, vtkCameraRepresentation, vtkCaptionRepresentation, vtkCenteredSliderRepresentation, vtkConstrainedPointHandleRepresentation, vtkCurveRepresentation, vtkEllipsoidTensorProbeRepresentation, vtkFinitePlaneRepresentation, vtkImplicitCylinderRepresentation, vtkImplicitPlaneRepresentation, vtkLineRepresentation, vtkLogoRepresentation, vtkOrientedGlyphContourRepresentation, vtkOrientedGlyphFocalPlaneContourRepresentation, vtkPlaybackRepresentation, vtkPointHandleRepresentation2D, vtkPointHandleRepresentation3D, vtkProgressBarRepresentation, vtkProp3DButtonRepresentation, vtkRectilinearWipeRepresentation, vtkSliderRepresentation2D, vtkSliderRepresentation3D, vtkSphereHandleRepresentation, vtkSphereRepresentation, vtkTensorProbeRepresentation, vtkTextRepresentation, vtkTexturedButtonRepresentation, vtkTexturedButtonRepresentation2D, vtkAngleRepresentation2D, vtkAngleRepresentation3D, vtkAxesTransformRepresentation, vtkBalloonRepresentation, vtkBiDimensionalRepresentation2D, vtkCheckerboardRepresentation, vtkDistanceRepresentation2D, vtkDistanceRepresentation3D, vtkParallelopipedRepresentation, vtkResliceCursorLineRepresentation, vtkContourRepresentation, vtkScalarBarRepresentation, and vtkXYPlotRepresentation.
Definition at line 186 of file vtkWidgetRepresentation.h.
|
inlinevirtual |
Definition at line 187 of file vtkWidgetRepresentation.h.
|
inlinevirtual |
Definition at line 188 of file vtkWidgetRepresentation.h.
|
inlinevirtual |
Definition at line 189 of file vtkWidgetRepresentation.h.
|
inlinevirtual |
Definition at line 190 of file vtkWidgetRepresentation.h.
|
inlinevirtual |
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS Does this prop have some translucent polygonal geometry? This method is called during the rendering process to know if there is some translucent polygonal geometry.
A simple prop that has some translucent polygonal geometry will return true. A composite prop (like vtkAssembly) that has at least one sub-prop that has some translucent polygonal geometry will return true. Default implementation return false.
Reimplemented from vtkProp.
Reimplemented in vtkAbstractPolygonalHandleRepresentation3D, vtkAngleRepresentation3D, vtkBorderRepresentation, vtkBoxRepresentation, vtkCameraRepresentation, vtkCaptionRepresentation, vtkCheckerboardRepresentation, vtkConstrainedPointHandleRepresentation, vtkCurveRepresentation, vtkFinitePlaneRepresentation, vtkImplicitCylinderRepresentation, vtkImplicitPlaneRepresentation, vtkLineRepresentation, vtkOrientedGlyphContourRepresentation, vtkOrientedGlyphFocalPlaneContourRepresentation, vtkPlaybackRepresentation, vtkPointHandleRepresentation3D, vtkProgressBarRepresentation, vtkProp3DButtonRepresentation, vtkRectilinearWipeRepresentation, vtkResliceCursorLineRepresentation, vtkScalarBarRepresentation, vtkSliderRepresentation3D, vtkSphereHandleRepresentation, vtkSphereRepresentation, vtkTextRepresentation, vtkTexturedButtonRepresentation, vtkTexturedButtonRepresentation2D, vtkXYPlotRepresentation, and vtkContourRepresentation.
Definition at line 191 of file vtkWidgetRepresentation.h.
|
protected |
|
protectedvirtual |
Register internal Pickers in the Picking Manager.
Must be reimplemented by concrete widget representations to register their pickers.
Reimplemented in vtkAbstractPolygonalHandleRepresentation3D, vtkBoxRepresentation, vtkCurveRepresentation, vtkEllipsoidTensorProbeRepresentation, vtkFinitePlaneRepresentation, vtkImplicitCylinderRepresentation, vtkImplicitPlaneRepresentation, vtkPointHandleRepresentation3D, vtkProp3DButtonRepresentation, vtkSliderRepresentation3D, vtkSphereHandleRepresentation, vtkSphereRepresentation, and vtkTexturedButtonRepresentation.
|
protectedvirtual |
Unregister internal pickers from the Picking Manager.
|
protectedvirtual |
Update the pickers registered in the Picking Manager when pickers are modified.
|
protected |
Return the picking manager associated on the context on which the widget representation currently belong.
|
protected |
Proceed to a pick, whether through the PickingManager if the picking is managed or directly using the registered picker, and return the assembly path.
|
protected |
|
protected |
Definition at line 198 of file vtkWidgetRepresentation.h.
|
protected |
Definition at line 201 of file vtkWidgetRepresentation.h.
|
protected |
Definition at line 205 of file vtkWidgetRepresentation.h.
|
protected |
Definition at line 208 of file vtkWidgetRepresentation.h.
|
protected |
Definition at line 209 of file vtkWidgetRepresentation.h.
|
protected |
Definition at line 211 of file vtkWidgetRepresentation.h.
|
protected |
Definition at line 212 of file vtkWidgetRepresentation.h.
|
protected |
Definition at line 219 of file vtkWidgetRepresentation.h.
|
protected |
Definition at line 223 of file vtkWidgetRepresentation.h.
|
protected |
Definition at line 261 of file vtkWidgetRepresentation.h.
|
protected |
Definition at line 266 of file vtkWidgetRepresentation.h.
|
protected |
Definition at line 270 of file vtkWidgetRepresentation.h.