VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
vtkImplicitPlaneRepresentation Class Reference

a class defining the representation for a vtkImplicitPlaneWidget2 More...

#include <vtkImplicitPlaneRepresentation.h>

Inheritance diagram for vtkImplicitPlaneRepresentation:
Inheritance graph
[legend]
Collaboration diagram for vtkImplicitPlaneRepresentation:
Collaboration graph
[legend]

List of all members.

Public Types

enum  _InteractionState {
  Outside = 0, Moving, MovingOutline, MovingOrigin,
  Rotating, Pushing, Scaling
}

Public Member Functions

void GetPolyData (vtkPolyData *pd)
vtkPolyDataAlgorithmGetPolyDataAlgorithm ()
void GetPlane (vtkPlane *plane)
void UpdatePlacement (void)
void BumpPlane (int dir, double factor)
void PushPlane (double distance)
void SetOrigin (double x, double y, double z)
void SetOrigin (double x[3])
doubleGetOrigin ()
void GetOrigin (double xyz[3])
void SetNormal (double x, double y, double z)
void SetNormal (double x[3])
void SetNormalToCamera ()
doubleGetNormal ()
void GetNormal (double xyz[3])
void SetNormalToXAxis (int)
virtual int GetNormalToXAxis ()
virtual void NormalToXAxisOn ()
virtual void NormalToXAxisOff ()
void SetNormalToYAxis (int)
virtual int GetNormalToYAxis ()
virtual void NormalToYAxisOn ()
virtual void NormalToYAxisOff ()
void SetNormalToZAxis (int)
virtual int GetNormalToZAxis ()
virtual void NormalToZAxisOn ()
virtual void NormalToZAxisOff ()
virtual void SetLockNormalToCamera (int)
virtual int GetLockNormalToCamera ()
virtual void LockNormalToCameraOn ()
virtual void LockNormalToCameraOff ()
virtual void SetTubing (int)
virtual int GetTubing ()
virtual void TubingOn ()
virtual void TubingOff ()
void SetDrawPlane (int plane)
virtual int GetDrawPlane ()
virtual void DrawPlaneOn ()
virtual void DrawPlaneOff ()
virtual void SetOutlineTranslation (int)
virtual int GetOutlineTranslation ()
virtual void OutlineTranslationOn ()
virtual void OutlineTranslationOff ()
virtual void SetOutsideBounds (int)
virtual int GetOutsideBounds ()
virtual void OutsideBoundsOn ()
virtual void OutsideBoundsOff ()
virtual void SetScaleEnabled (int)
virtual int GetScaleEnabled ()
virtual void ScaleEnabledOn ()
virtual void ScaleEnabledOff ()
virtual vtkPropertyGetNormalProperty ()
virtual vtkPropertyGetSelectedNormalProperty ()
virtual vtkPropertyGetPlaneProperty ()
virtual vtkPropertyGetSelectedPlaneProperty ()
virtual vtkPropertyGetOutlineProperty ()
virtual vtkPropertyGetSelectedOutlineProperty ()
virtual vtkPropertyGetEdgesProperty ()
void SetEdgeColor (vtkLookupTable *)
void SetEdgeColor (double, double, double)
void SetEdgeColor (double x[3])
virtual void SetBumpDistance (double)
virtual double GetBumpDistance ()
virtual int ComputeInteractionState (int X, int Y, int modify=0)
virtual void PlaceWidget (double bounds[6])
virtual void BuildRepresentation ()
virtual void StartWidgetInteraction (double eventPos[2])
virtual void WidgetInteraction (double newEventPos[2])
virtual void EndWidgetInteraction (double newEventPos[2])
virtual doubleGetBounds ()
virtual void GetActors (vtkPropCollection *pc)
virtual void ReleaseGraphicsResources (vtkWindow *)
virtual int RenderOpaqueGeometry (vtkViewport *)
virtual int RenderTranslucentPolygonalGeometry (vtkViewport *)
virtual int HasTranslucentPolygonalGeometry ()
virtual void SetInteractionState (int)
virtual void SetRepresentationState (int)
virtual int GetRepresentationState ()

Static Public Member Functions

static
vtkImplicitPlaneRepresentation
New ()

Protected Member Functions

 vtkImplicitPlaneRepresentation ()
 ~vtkImplicitPlaneRepresentation ()
void HighlightOutline (int highlight)
void HighlightPlane (int highlight)
void HighlightNormal (int highlight)
virtual void RegisterPickers ()
void ConstrainOrigin (double x[3])
void Rotate (double X, double Y, double *p1, double *p2, double *vpn)
void TranslatePlane (double *p1, double *p2)
void TranslateOutline (double *p1, double *p2)
void TranslateOrigin (double *p1, double *p2)
void Push (double *p1, double *p2)
void Scale (double *p1, double *p2, double X, double Y)
void SizeHandles ()
void CreateDefaultProperties ()
void GeneratePlane ()

Protected Attributes

int RepresentationState
double LastEventPosition [3]
int NormalToXAxis
int NormalToYAxis
int NormalToZAxis
int LockNormalToCamera
double BumpDistance
vtkPlanePlane
vtkImageDataBox
vtkOutlineFilterOutline
vtkPolyDataMapperOutlineMapper
vtkActorOutlineActor
int OutlineTranslation
int ScaleEnabled
int OutsideBounds
vtkCutterCutter
vtkPolyDataMapperCutMapper
vtkActorCutActor
int DrawPlane
vtkFeatureEdgesEdges
vtkTubeFilterEdgesTuber
vtkPolyDataMapperEdgesMapper
vtkActorEdgesActor
int Tubing
vtkConeSourceConeSource
vtkPolyDataMapperConeMapper
vtkActorConeActor
vtkLineSourceLineSource
vtkPolyDataMapperLineMapper
vtkActorLineActor
vtkConeSourceConeSource2
vtkPolyDataMapperConeMapper2
vtkActorConeActor2
vtkLineSourceLineSource2
vtkPolyDataMapperLineMapper2
vtkActorLineActor2
vtkSphereSourceSphere
vtkPolyDataMapperSphereMapper
vtkActorSphereActor
vtkCellPickerPicker
vtkTransformTransform
vtkPropertyNormalProperty
vtkPropertySelectedNormalProperty
vtkPropertyPlaneProperty
vtkPropertySelectedPlaneProperty
vtkPropertyOutlineProperty
vtkPropertySelectedOutlineProperty
vtkPropertyEdgesProperty
vtkBoxBoundingBox
typedef vtkWidgetRepresentation Superclass
static int IsTypeOf (const char *type)
static
vtkImplicitPlaneRepresentation
SafeDownCast (vtkObjectBase *o)
virtual int IsA (const char *type)
vtkImplicitPlaneRepresentationNewInstance () const
void PrintSelf (ostream &os, vtkIndent indent)
virtual vtkObjectBaseNewInstanceInternal () const

Detailed Description

a class defining the representation for a vtkImplicitPlaneWidget2

This class is a concrete representation for the vtkImplicitPlaneWidget2. It represents an infinite plane defined by a normal and point in the context of a bounding box. Through interaction with the widget, the plane can be manipulated by adjusting the plane normal or moving the origin point.

To use this representation, you normally define a (plane) origin and (plane) normal. The PlaceWidget() method is also used to initially position the representation.

Warning:
This class, and vtkImplicitPlaneWidget2, are next generation VTK widgets. An earlier version of this functionality was defined in the class vtkImplicitPlaneWidget.
See also:
vtkImplicitPlaneWidget2 vtkImplicitPlaneWidget
Tests:
vtkImplicitPlaneRepresentation (Tests)

Definition at line 65 of file vtkImplicitPlaneRepresentation.h.


Member Typedef Documentation

Standard methods for the class.

Reimplemented from vtkWidgetRepresentation.

Definition at line 73 of file vtkImplicitPlaneRepresentation.h.


Member Enumeration Documentation

Enumerator:
Outside 
Moving 
MovingOutline 
MovingOrigin 
Rotating 
Pushing 
Scaling 

Definition at line 251 of file vtkImplicitPlaneRepresentation.h.


Constructor & Destructor Documentation


Member Function Documentation

Instantiate the class.

Reimplemented from vtkObject.

static int vtkImplicitPlaneRepresentation::IsTypeOf ( const char *  type) [static]

Standard methods for the class.

Reimplemented from vtkWidgetRepresentation.

virtual int vtkImplicitPlaneRepresentation::IsA ( const char *  type) [virtual]

Standard methods for the class.

Reimplemented from vtkWidgetRepresentation.

Standard methods for the class.

Reimplemented from vtkWidgetRepresentation.

virtual vtkObjectBase* vtkImplicitPlaneRepresentation::NewInstanceInternal ( ) const [protected, virtual]

Standard methods for the class.

Reimplemented from vtkWidgetRepresentation.

Standard methods for the class.

Reimplemented from vtkWidgetRepresentation.

void vtkImplicitPlaneRepresentation::PrintSelf ( ostream &  os,
vtkIndent  indent 
) [virtual]

Standard methods for the class.

Reimplemented from vtkWidgetRepresentation.

Get the origin of the plane.

Get the origin of the plane.

Get the origin of the plane.

Get the origin of the plane.

Get the normal to the plane.

Get the normal to the plane.

Get the normal to the plane.

Get the normal to the plane.

Get the normal to the plane.

Force the plane widget to be aligned with one of the x-y-z axes. If one axis is set on, the other two will be set off. Remember that when the state changes, a ModifiedEvent is invoked. This can be used to snap the plane to the axes if it is originally not aligned.

Force the plane widget to be aligned with one of the x-y-z axes. If one axis is set on, the other two will be set off. Remember that when the state changes, a ModifiedEvent is invoked. This can be used to snap the plane to the axes if it is originally not aligned.

Force the plane widget to be aligned with one of the x-y-z axes. If one axis is set on, the other two will be set off. Remember that when the state changes, a ModifiedEvent is invoked. This can be used to snap the plane to the axes if it is originally not aligned.

Force the plane widget to be aligned with one of the x-y-z axes. If one axis is set on, the other two will be set off. Remember that when the state changes, a ModifiedEvent is invoked. This can be used to snap the plane to the axes if it is originally not aligned.

Force the plane widget to be aligned with one of the x-y-z axes. If one axis is set on, the other two will be set off. Remember that when the state changes, a ModifiedEvent is invoked. This can be used to snap the plane to the axes if it is originally not aligned.

Force the plane widget to be aligned with one of the x-y-z axes. If one axis is set on, the other two will be set off. Remember that when the state changes, a ModifiedEvent is invoked. This can be used to snap the plane to the axes if it is originally not aligned.

Force the plane widget to be aligned with one of the x-y-z axes. If one axis is set on, the other two will be set off. Remember that when the state changes, a ModifiedEvent is invoked. This can be used to snap the plane to the axes if it is originally not aligned.

Force the plane widget to be aligned with one of the x-y-z axes. If one axis is set on, the other two will be set off. Remember that when the state changes, a ModifiedEvent is invoked. This can be used to snap the plane to the axes if it is originally not aligned.

Force the plane widget to be aligned with one of the x-y-z axes. If one axis is set on, the other two will be set off. Remember that when the state changes, a ModifiedEvent is invoked. This can be used to snap the plane to the axes if it is originally not aligned.

Force the plane widget to be aligned with one of the x-y-z axes. If one axis is set on, the other two will be set off. Remember that when the state changes, a ModifiedEvent is invoked. This can be used to snap the plane to the axes if it is originally not aligned.

Force the plane widget to be aligned with one of the x-y-z axes. If one axis is set on, the other two will be set off. Remember that when the state changes, a ModifiedEvent is invoked. This can be used to snap the plane to the axes if it is originally not aligned.

Force the plane widget to be aligned with one of the x-y-z axes. If one axis is set on, the other two will be set off. Remember that when the state changes, a ModifiedEvent is invoked. This can be used to snap the plane to the axes if it is originally not aligned.

If enabled, and a vtkCamera is available through the renderer, then LockNormalToCamera will cause the normal to follow the camera's normal.

If enabled, and a vtkCamera is available through the renderer, then LockNormalToCamera will cause the normal to follow the camera's normal.

If enabled, and a vtkCamera is available through the renderer, then LockNormalToCamera will cause the normal to follow the camera's normal.

If enabled, and a vtkCamera is available through the renderer, then LockNormalToCamera will cause the normal to follow the camera's normal.

virtual void vtkImplicitPlaneRepresentation::SetTubing ( int  ) [virtual]

Turn on/off tubing of the wire outline of the plane. The tube thickens the line by wrapping with a vtkTubeFilter.

Turn on/off tubing of the wire outline of the plane. The tube thickens the line by wrapping with a vtkTubeFilter.

virtual void vtkImplicitPlaneRepresentation::TubingOn ( ) [virtual]

Turn on/off tubing of the wire outline of the plane. The tube thickens the line by wrapping with a vtkTubeFilter.

virtual void vtkImplicitPlaneRepresentation::TubingOff ( ) [virtual]

Turn on/off tubing of the wire outline of the plane. The tube thickens the line by wrapping with a vtkTubeFilter.

Enable/disable the drawing of the plane. In some cases the plane interferes with the object that it is operating on (i.e., the plane interferes with the cut surface it produces producing z-buffer artifacts.)

Enable/disable the drawing of the plane. In some cases the plane interferes with the object that it is operating on (i.e., the plane interferes with the cut surface it produces producing z-buffer artifacts.)

virtual void vtkImplicitPlaneRepresentation::DrawPlaneOn ( ) [virtual]

Enable/disable the drawing of the plane. In some cases the plane interferes with the object that it is operating on (i.e., the plane interferes with the cut surface it produces producing z-buffer artifacts.)

Enable/disable the drawing of the plane. In some cases the plane interferes with the object that it is operating on (i.e., the plane interferes with the cut surface it produces producing z-buffer artifacts.)

Turn on/off the ability to translate the bounding box by grabbing it with the left mouse button.

Turn on/off the ability to translate the bounding box by grabbing it with the left mouse button.

Turn on/off the ability to translate the bounding box by grabbing it with the left mouse button.

Turn on/off the ability to translate the bounding box by grabbing it with the left mouse button.

Turn on/off the ability to move the widget outside of the bounds specified in the initial PlaceWidget() invocation.

Turn on/off the ability to move the widget outside of the bounds specified in the initial PlaceWidget() invocation.

Turn on/off the ability to move the widget outside of the bounds specified in the initial PlaceWidget() invocation.

Turn on/off the ability to move the widget outside of the bounds specified in the initial PlaceWidget() invocation.

Turn on/off the ability to scale the widget with the mouse.

Turn on/off the ability to scale the widget with the mouse.

Turn on/off the ability to scale the widget with the mouse.

Turn on/off the ability to scale the widget with the mouse.

Grab the polydata that defines the plane. The polydata contains a single polygon that is clipped by the bounding box.

Satisfies superclass API. This returns a pointer to the underlying PolyData (which represents the plane).

Get the implicit function for the plane. The user must provide the instance of the class vtkPlane. Note that vtkPlane is a subclass of vtkImplicitFunction, meaning that it can be used by a variety of filters to perform clipping, cutting, and selection of data.

Satisfies the superclass API. This will change the state of the widget to match changes that have been made to the underlying PolyDataSource

Get the properties on the normal (line and cone).

Get the properties on the normal (line and cone).

Get the plane properties. The properties of the plane when selected and unselected can be manipulated.

Get the plane properties. The properties of the plane when selected and unselected can be manipulated.

Get the property of the outline.

Get the property of the outline.

Get the property of the intersection edges. (This property also applies to the edges when tubed.)

Set color to the edge

Set color to the edge

Set color to the edge

Specify a translation distance used by the BumpPlane() method. Note that the distance is normalized; it is the fraction of the length of the bounding box of the wire outline.

Specify a translation distance used by the BumpPlane() method. Note that the distance is normalized; it is the fraction of the length of the bounding box of the wire outline.

Translate the plane in the direction of the normal by the specified BumpDistance. The dir parameter controls which direction the pushing occurs, either in the same direction as the normal, or when negative, in the opposite direction. The factor controls whether what percentage of the bump is used.

Push the plane the distance specified along the normal. Positive values are in the direction of the normal; negative values are in the opposite direction of the normal. The distance value is expressed in world coordinates.

virtual int vtkImplicitPlaneRepresentation::ComputeInteractionState ( int  X,
int  Y,
int  modify = 0 
) [virtual]

Methods to interface with the vtkSliderWidget.

Reimplemented from vtkWidgetRepresentation.

virtual void vtkImplicitPlaneRepresentation::PlaceWidget ( double  bounds[6]) [virtual]

Methods to interface with the vtkSliderWidget.

Methods to interface with the vtkSliderWidget.

Implements vtkWidgetRepresentation.

virtual void vtkImplicitPlaneRepresentation::StartWidgetInteraction ( double  eventPos[2]) [virtual]

Methods to interface with the vtkSliderWidget.

Reimplemented from vtkWidgetRepresentation.

virtual void vtkImplicitPlaneRepresentation::WidgetInteraction ( double  newEventPos[2]) [virtual]

Methods to interface with the vtkSliderWidget.

Reimplemented from vtkWidgetRepresentation.

virtual void vtkImplicitPlaneRepresentation::EndWidgetInteraction ( double  newEventPos[2]) [virtual]

Methods to interface with the vtkSliderWidget.

Reimplemented from vtkWidgetRepresentation.

Methods supporting the rendering process.

Reimplemented from vtkWidgetRepresentation.

Methods supporting the rendering process.

Reimplemented from vtkWidgetRepresentation.

Methods supporting the rendering process.

Reimplemented from vtkWidgetRepresentation.

Methods supporting the rendering process.

Reimplemented from vtkProp.

Methods supporting the rendering process.

Reimplemented from vtkProp.

Methods supporting the rendering process.

Reimplemented from vtkWidgetRepresentation.

The interaction state may be set from a widget (e.g., vtkImplicitPlaneWidget2) or other object. This controls how the interaction with the widget proceeds. Normally this method is used as part of a handshaking process with 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.

Sets the visual appearance of the representation based on the state it is in. This state is usually the same as InteractionState.

Sets the visual appearance of the representation based on the state it is in. This state is usually the same as InteractionState.

void vtkImplicitPlaneRepresentation::HighlightOutline ( int  highlight) [protected]
void vtkImplicitPlaneRepresentation::HighlightPlane ( int  highlight) [protected]
void vtkImplicitPlaneRepresentation::HighlightNormal ( int  highlight) [protected]
virtual void vtkImplicitPlaneRepresentation::RegisterPickers ( ) [protected, virtual]

Register internal Pickers in the Picking Manager. Must be reimplemented by concrete widget representations to register their pickers.

Reimplemented from vtkWidgetRepresentation.

void vtkImplicitPlaneRepresentation::Rotate ( double  X,
double  Y,
double p1,
double p2,
double vpn 
) [protected]
void vtkImplicitPlaneRepresentation::TranslatePlane ( double p1,
double p2 
) [protected]
void vtkImplicitPlaneRepresentation::TranslateOutline ( double p1,
double p2 
) [protected]
void vtkImplicitPlaneRepresentation::TranslateOrigin ( double p1,
double p2 
) [protected]
void vtkImplicitPlaneRepresentation::Push ( double p1,
double p2 
) [protected]
void vtkImplicitPlaneRepresentation::Scale ( double p1,
double p2,
double  X,
double  Y 
) [protected]

Member Data Documentation

Definition at line 285 of file vtkImplicitPlaneRepresentation.h.

Definition at line 288 of file vtkImplicitPlaneRepresentation.h.

Definition at line 291 of file vtkImplicitPlaneRepresentation.h.

Definition at line 292 of file vtkImplicitPlaneRepresentation.h.

Definition at line 293 of file vtkImplicitPlaneRepresentation.h.

Definition at line 296 of file vtkImplicitPlaneRepresentation.h.

Definition at line 299 of file vtkImplicitPlaneRepresentation.h.

Definition at line 302 of file vtkImplicitPlaneRepresentation.h.

Definition at line 305 of file vtkImplicitPlaneRepresentation.h.

Definition at line 306 of file vtkImplicitPlaneRepresentation.h.

Definition at line 307 of file vtkImplicitPlaneRepresentation.h.

Definition at line 308 of file vtkImplicitPlaneRepresentation.h.

Definition at line 310 of file vtkImplicitPlaneRepresentation.h.

Definition at line 311 of file vtkImplicitPlaneRepresentation.h.

Definition at line 312 of file vtkImplicitPlaneRepresentation.h.

Definition at line 315 of file vtkImplicitPlaneRepresentation.h.

Definition at line 316 of file vtkImplicitPlaneRepresentation.h.

Definition at line 317 of file vtkImplicitPlaneRepresentation.h.

Definition at line 318 of file vtkImplicitPlaneRepresentation.h.

Definition at line 322 of file vtkImplicitPlaneRepresentation.h.

Definition at line 323 of file vtkImplicitPlaneRepresentation.h.

Definition at line 324 of file vtkImplicitPlaneRepresentation.h.

Definition at line 325 of file vtkImplicitPlaneRepresentation.h.

Definition at line 326 of file vtkImplicitPlaneRepresentation.h.

Definition at line 329 of file vtkImplicitPlaneRepresentation.h.

Definition at line 330 of file vtkImplicitPlaneRepresentation.h.

Definition at line 331 of file vtkImplicitPlaneRepresentation.h.

Definition at line 335 of file vtkImplicitPlaneRepresentation.h.

Definition at line 336 of file vtkImplicitPlaneRepresentation.h.

Definition at line 337 of file vtkImplicitPlaneRepresentation.h.

Definition at line 340 of file vtkImplicitPlaneRepresentation.h.

Definition at line 341 of file vtkImplicitPlaneRepresentation.h.

Definition at line 342 of file vtkImplicitPlaneRepresentation.h.

Definition at line 345 of file vtkImplicitPlaneRepresentation.h.

Definition at line 346 of file vtkImplicitPlaneRepresentation.h.

Definition at line 347 of file vtkImplicitPlaneRepresentation.h.

Definition at line 350 of file vtkImplicitPlaneRepresentation.h.

Definition at line 351 of file vtkImplicitPlaneRepresentation.h.

Definition at line 352 of file vtkImplicitPlaneRepresentation.h.

Definition at line 355 of file vtkImplicitPlaneRepresentation.h.

Definition at line 361 of file vtkImplicitPlaneRepresentation.h.

Definition at line 375 of file vtkImplicitPlaneRepresentation.h.

Definition at line 376 of file vtkImplicitPlaneRepresentation.h.

Definition at line 377 of file vtkImplicitPlaneRepresentation.h.

Definition at line 378 of file vtkImplicitPlaneRepresentation.h.

Definition at line 379 of file vtkImplicitPlaneRepresentation.h.

Definition at line 380 of file vtkImplicitPlaneRepresentation.h.

Definition at line 381 of file vtkImplicitPlaneRepresentation.h.

Definition at line 387 of file vtkImplicitPlaneRepresentation.h.


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