vtkBoxRepresentation Class Reference

#include <vtkBoxRepresentation.h>

Inheritance diagram for vtkBoxRepresentation:

Inheritance graph
[legend]
Collaboration diagram for vtkBoxRepresentation:

Collaboration graph
[legend]

List of all members.


Detailed Description

a class defining the representation for the vtkBoxWidget2

This class is a concrete representation for the vtkBoxWidget2. It represents a box with seven handles: one on each of the six faces, plus a center handle. Through interaction with the widget, the box representation can be arbitrarily positioned in the 3D space.

To use this representation, you normally use the PlaceWidget() method to position the widget at a specified region in space.

Warning:
This class, and vtkBoxWidget2, are second generation VTK widgets. An earlier version of this functionality was defined in the class vtkBoxWidget.
See also:
vtkBoxWidget2 vtkBoxWidget
Tests:
vtkBoxRepresentation (Tests)

Definition at line 60 of file vtkBoxRepresentation.h.

typedef vtkWidgetRepresentation Superclass
static int IsTypeOf (const char *type)
static vtkBoxRepresentationSafeDownCast (vtkObject *o)
virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)

Public Types

enum  {
  Outside = 0, MoveF0, MoveF1, MoveF2,
  MoveF3, MoveF4, MoveF5, Translating,
  Rotating, Scaling
}

Public Member Functions

void GetPlanes (vtkPlanes *planes)
virtual void GetTransform (vtkTransform *t)
virtual void SetTransform (vtkTransform *t)
void GetPolyData (vtkPolyData *pd)
void SetInteractionState (int state)
virtual void SetInsideOut (int)
virtual int GetInsideOut ()
virtual void InsideOutOn ()
virtual void InsideOutOff ()
virtual vtkPropertyGetHandleProperty ()
virtual vtkPropertyGetSelectedHandleProperty ()
virtual vtkPropertyGetFaceProperty ()
virtual vtkPropertyGetSelectedFaceProperty ()
virtual vtkPropertyGetOutlineProperty ()
virtual vtkPropertyGetSelectedOutlineProperty ()
void SetOutlineFaceWires (int)
virtual int GetOutlineFaceWires ()
void OutlineFaceWiresOn ()
void OutlineFaceWiresOff ()
void SetOutlineCursorWires (int)
virtual int GetOutlineCursorWires ()
void OutlineCursorWiresOn ()
void OutlineCursorWiresOff ()
virtual void HandlesOn ()
virtual void HandlesOff ()
virtual void PlaceWidget (double bounds[6])
virtual void BuildRepresentation ()
virtual int ComputeInteractionState (int X, int Y, int modify=0)
virtual void StartWidgetInteraction (double e[2])
virtual void WidgetInteraction (double e[2])
virtual double * GetBounds ()
virtual void ReleaseGraphicsResources (vtkWindow *)
virtual int RenderOpaqueGeometry (vtkViewport *)
virtual int RenderTranslucentPolygonalGeometry (vtkViewport *)
virtual int HasTranslucentPolygonalGeometry ()

Static Public Member Functions

static vtkBoxRepresentationNew ()

Protected Member Functions

 vtkBoxRepresentation ()
 ~vtkBoxRepresentation ()
virtual void PositionHandles ()
int HighlightHandle (vtkProp *prop)
void HighlightFace (int cellId)
void HighlightOutline (int highlight)
virtual void ComputeNormals ()
virtual void SizeHandles ()
virtual void CreateDefaultProperties ()
void GenerateOutline ()
virtual void Translate (double *p1, double *p2)
virtual void Scale (double *p1, double *p2, int X, int Y)
virtual void Rotate (int X, int Y, double *p1, double *p2, double *vpn)
void MovePlusXFace (double *p1, double *p2)
void MoveMinusXFace (double *p1, double *p2)
void MovePlusYFace (double *p1, double *p2)
void MoveMinusYFace (double *p1, double *p2)
void MovePlusZFace (double *p1, double *p2)
void MoveMinusZFace (double *p1, double *p2)
void MoveFace (double *p1, double *p2, double *dir, double *x1, double *x2, double *x3, double *x4, double *x5)
void GetDirection (const double Nx[3], const double Ny[3], const double Nz[3], double dir[3])

Protected Attributes

double LastEventPosition [3]
vtkActorHexActor
vtkPolyDataMapperHexMapper
vtkPolyDataHexPolyData
vtkPointsPoints
double N [6][3]
vtkActorHexFace
vtkPolyDataMapperHexFaceMapper
vtkPolyDataHexFacePolyData
vtkActor ** Handle
vtkPolyDataMapper ** HandleMapper
vtkSphereSource ** HandleGeometry
vtkActorHexOutline
vtkPolyDataMapperOutlineMapper
vtkPolyDataOutlinePolyData
vtkCellPickerHandlePicker
vtkCellPickerHexPicker
vtkActorCurrentHandle
int CurrentHexFace
vtkCellPickerLastPicker
vtkTransformTransform
vtkBoxBoundingBox
vtkPropertyHandleProperty
vtkPropertySelectedHandleProperty
vtkPropertyFaceProperty
vtkPropertySelectedFaceProperty
vtkPropertyOutlineProperty
vtkPropertySelectedOutlineProperty
int InsideOut
int OutlineFaceWires
int OutlineCursorWires
vtkPointsPlanePoints
vtkDoubleArrayPlaneNormals
vtkMatrix4x4Matrix

Member Typedef Documentation

Standard methods for the class.

Reimplemented from vtkWidgetRepresentation.

Definition at line 68 of file vtkBoxRepresentation.h.


Member Enumeration Documentation

anonymous enum

Enumerator:
Outside 
MoveF0 
MoveF1 
MoveF2 
MoveF3 
MoveF4 
MoveF5 
Translating 
Rotating 
Scaling 

Definition at line 180 of file vtkBoxRepresentation.h.


Constructor & Destructor Documentation

vtkBoxRepresentation::vtkBoxRepresentation (  )  [protected]

vtkBoxRepresentation::~vtkBoxRepresentation (  )  [protected]


Member Function Documentation

static vtkBoxRepresentation* vtkBoxRepresentation::New (  )  [static]

Instantiate the class.

Reimplemented from vtkObject.

virtual const char* vtkBoxRepresentation::GetClassName (  )  [virtual]

Standard methods for the class.

Reimplemented from vtkWidgetRepresentation.

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

Standard methods for the class.

Reimplemented from vtkWidgetRepresentation.

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

Standard methods for the class.

Reimplemented from vtkWidgetRepresentation.

static vtkBoxRepresentation* vtkBoxRepresentation::SafeDownCast ( vtkObject o  )  [static]

Standard methods for the class.

Reimplemented from vtkWidgetRepresentation.

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

Standard methods for the class.

Reimplemented from vtkWidgetRepresentation.

void vtkBoxRepresentation::GetPlanes ( vtkPlanes planes  ) 

Get the planes describing the implicit function defined by the box widget. The user must provide the instance of the class vtkPlanes. Note that vtkPlanes is a subclass of vtkImplicitFunction, meaning that it can be used by a variety of filters to perform clipping, cutting, and selection of data. (The direction of the normals of the planes can be reversed enabling the InsideOut flag.)

virtual void vtkBoxRepresentation::SetInsideOut ( int   )  [virtual]

Set/Get the InsideOut flag. This data memeber is used in conjunction with the GetPlanes() method. When off, the normals point out of the box. When on, the normals point into the hexahedron. InsideOut is off by default.

virtual int vtkBoxRepresentation::GetInsideOut (  )  [virtual]

Set/Get the InsideOut flag. This data memeber is used in conjunction with the GetPlanes() method. When off, the normals point out of the box. When on, the normals point into the hexahedron. InsideOut is off by default.

virtual void vtkBoxRepresentation::InsideOutOn (  )  [virtual]

Set/Get the InsideOut flag. This data memeber is used in conjunction with the GetPlanes() method. When off, the normals point out of the box. When on, the normals point into the hexahedron. InsideOut is off by default.

virtual void vtkBoxRepresentation::InsideOutOff (  )  [virtual]

Set/Get the InsideOut flag. This data memeber is used in conjunction with the GetPlanes() method. When off, the normals point out of the box. When on, the normals point into the hexahedron. InsideOut is off by default.

virtual void vtkBoxRepresentation::GetTransform ( vtkTransform t  )  [virtual]

Retrieve a linear transform characterizing the transformation of the box. Note that the transformation is relative to where PlaceWidget() was initially called. This method modifies the transform provided. The transform can be used to control the position of vtkProp3D's, as well as other transformation operations (e.g., vtkTranformPolyData).

virtual void vtkBoxRepresentation::SetTransform ( vtkTransform t  )  [virtual]

Set the position, scale and orientation of the box widget using the transform specified. Note that the transformation is relative to where PlaceWidget() was initially called (i.e., the original bounding box).

void vtkBoxRepresentation::GetPolyData ( vtkPolyData pd  ) 

Grab the polydata (including points) that define the box widget. The polydata consists of 6 quadrilateral faces and 15 points. The first eight points define the eight corner vertices; the next six define the -x,+x, -y,+y, -z,+z face points; and the final point (the 15th out of 15 points) defines the center of the box. These point values are guaranteed to be up-to-date when either the widget's corresponding InteractionEvent or EndInteractionEvent events are invoked. The user provides the vtkPolyData and the points and cells are added to it.

virtual vtkProperty* vtkBoxRepresentation::GetHandleProperty (  )  [virtual]

Get the handle properties (the little balls are the handles). The properties of the handles, when selected or normal, can be specified.

virtual vtkProperty* vtkBoxRepresentation::GetSelectedHandleProperty (  )  [virtual]

Get the handle properties (the little balls are the handles). The properties of the handles, when selected or normal, can be specified.

virtual vtkProperty* vtkBoxRepresentation::GetFaceProperty (  )  [virtual]

Get the face properties (the faces of the box). The properties of the face when selected and normal can be set.

virtual vtkProperty* vtkBoxRepresentation::GetSelectedFaceProperty (  )  [virtual]

Get the face properties (the faces of the box). The properties of the face when selected and normal can be set.

virtual vtkProperty* vtkBoxRepresentation::GetOutlineProperty (  )  [virtual]

Get the outline properties (the outline of the box). The properties of the outline when selected and normal can be set.

virtual vtkProperty* vtkBoxRepresentation::GetSelectedOutlineProperty (  )  [virtual]

Get the outline properties (the outline of the box). The properties of the outline when selected and normal can be set.

void vtkBoxRepresentation::SetOutlineFaceWires ( int   ) 

Control the representation of the outline. This flag enables face wires. By default face wires are off.

virtual int vtkBoxRepresentation::GetOutlineFaceWires (  )  [virtual]

Control the representation of the outline. This flag enables face wires. By default face wires are off.

void vtkBoxRepresentation::OutlineFaceWiresOn (  )  [inline]

Control the representation of the outline. This flag enables face wires. By default face wires are off.

Definition at line 140 of file vtkBoxRepresentation.h.

void vtkBoxRepresentation::OutlineFaceWiresOff (  )  [inline]

Control the representation of the outline. This flag enables face wires. By default face wires are off.

Definition at line 141 of file vtkBoxRepresentation.h.

void vtkBoxRepresentation::SetOutlineCursorWires ( int   ) 

Control the representation of the outline. This flag enables the cursor lines running between the handles. By default cursor wires are on.

virtual int vtkBoxRepresentation::GetOutlineCursorWires (  )  [virtual]

Control the representation of the outline. This flag enables the cursor lines running between the handles. By default cursor wires are on.

void vtkBoxRepresentation::OutlineCursorWiresOn (  )  [inline]

Control the representation of the outline. This flag enables the cursor lines running between the handles. By default cursor wires are on.

Definition at line 150 of file vtkBoxRepresentation.h.

void vtkBoxRepresentation::OutlineCursorWiresOff (  )  [inline]

Control the representation of the outline. This flag enables the cursor lines running between the handles. By default cursor wires are on.

Definition at line 151 of file vtkBoxRepresentation.h.

virtual void vtkBoxRepresentation::HandlesOn (  )  [virtual]

Switches handles (the spheres) on or off by manipulating the underlying actor visibility.

virtual void vtkBoxRepresentation::HandlesOff (  )  [virtual]

Switches handles (the spheres) on or off by manipulating the underlying actor visibility.

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

These are methods that satisfy vtkWidgetRepresentation's API.

virtual void vtkBoxRepresentation::BuildRepresentation (  )  [virtual]

These are methods that satisfy vtkWidgetRepresentation's API.

Implements vtkWidgetRepresentation.

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

These are methods that satisfy vtkWidgetRepresentation's API.

Reimplemented from vtkWidgetRepresentation.

virtual void vtkBoxRepresentation::StartWidgetInteraction ( double  e[2]  )  [virtual]

These are methods that satisfy vtkWidgetRepresentation's API.

Reimplemented from vtkWidgetRepresentation.

virtual void vtkBoxRepresentation::WidgetInteraction ( double  e[2]  )  [virtual]

These are methods that satisfy vtkWidgetRepresentation's API.

Reimplemented from vtkWidgetRepresentation.

virtual double* vtkBoxRepresentation::GetBounds (  )  [virtual]

These are methods that satisfy vtkWidgetRepresentation's API.

Reimplemented from vtkWidgetRepresentation.

virtual void vtkBoxRepresentation::ReleaseGraphicsResources ( vtkWindow  )  [virtual]

Methods supporting, and required by, the rendering process.

Reimplemented from vtkWidgetRepresentation.

virtual int vtkBoxRepresentation::RenderOpaqueGeometry ( vtkViewport  )  [virtual]

Methods supporting, and required by, the rendering process.

Reimplemented from vtkProp.

virtual int vtkBoxRepresentation::RenderTranslucentPolygonalGeometry ( vtkViewport  )  [virtual]

Methods supporting, and required by, the rendering process.

Reimplemented from vtkProp.

virtual int vtkBoxRepresentation::HasTranslucentPolygonalGeometry (  )  [virtual]

Methods supporting, and required by, the rendering process.

Reimplemented from vtkWidgetRepresentation.

void vtkBoxRepresentation::SetInteractionState ( int  state  ) 

The interaction state may be set from a widget (e.g., vtkBoxWidget2) 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.

virtual void vtkBoxRepresentation::PositionHandles (  )  [protected, virtual]

int vtkBoxRepresentation::HighlightHandle ( vtkProp prop  )  [protected]

void vtkBoxRepresentation::HighlightFace ( int  cellId  )  [protected]

void vtkBoxRepresentation::HighlightOutline ( int  highlight  )  [protected]

virtual void vtkBoxRepresentation::ComputeNormals (  )  [protected, virtual]

virtual void vtkBoxRepresentation::SizeHandles (  )  [protected, virtual]

virtual void vtkBoxRepresentation::CreateDefaultProperties (  )  [protected, virtual]

void vtkBoxRepresentation::GenerateOutline (  )  [protected]

virtual void vtkBoxRepresentation::Translate ( double *  p1,
double *  p2 
) [protected, virtual]

virtual void vtkBoxRepresentation::Scale ( double *  p1,
double *  p2,
int  X,
int  Y 
) [protected, virtual]

virtual void vtkBoxRepresentation::Rotate ( int  X,
int  Y,
double *  p1,
double *  p2,
double *  vpn 
) [protected, virtual]

void vtkBoxRepresentation::MovePlusXFace ( double *  p1,
double *  p2 
) [protected]

void vtkBoxRepresentation::MoveMinusXFace ( double *  p1,
double *  p2 
) [protected]

void vtkBoxRepresentation::MovePlusYFace ( double *  p1,
double *  p2 
) [protected]

void vtkBoxRepresentation::MoveMinusYFace ( double *  p1,
double *  p2 
) [protected]

void vtkBoxRepresentation::MovePlusZFace ( double *  p1,
double *  p2 
) [protected]

void vtkBoxRepresentation::MoveMinusZFace ( double *  p1,
double *  p2 
) [protected]

void vtkBoxRepresentation::MoveFace ( double *  p1,
double *  p2,
double *  dir,
double *  x1,
double *  x2,
double *  x3,
double *  x4,
double *  x5 
) [protected]

void vtkBoxRepresentation::GetDirection ( const double  Nx[3],
const double  Ny[3],
const double  Nz[3],
double  dir[3] 
) [protected]


Member Data Documentation

Definition at line 197 of file vtkBoxRepresentation.h.

Definition at line 200 of file vtkBoxRepresentation.h.

Definition at line 201 of file vtkBoxRepresentation.h.

Definition at line 202 of file vtkBoxRepresentation.h.

Definition at line 203 of file vtkBoxRepresentation.h.

double vtkBoxRepresentation::N[6][3] [protected]

Definition at line 204 of file vtkBoxRepresentation.h.

Definition at line 207 of file vtkBoxRepresentation.h.

Definition at line 208 of file vtkBoxRepresentation.h.

Definition at line 209 of file vtkBoxRepresentation.h.

Definition at line 212 of file vtkBoxRepresentation.h.

Definition at line 213 of file vtkBoxRepresentation.h.

Definition at line 214 of file vtkBoxRepresentation.h.

Definition at line 223 of file vtkBoxRepresentation.h.

Definition at line 224 of file vtkBoxRepresentation.h.

Definition at line 225 of file vtkBoxRepresentation.h.

Definition at line 228 of file vtkBoxRepresentation.h.

Definition at line 229 of file vtkBoxRepresentation.h.

Definition at line 230 of file vtkBoxRepresentation.h.

Definition at line 231 of file vtkBoxRepresentation.h.

Definition at line 232 of file vtkBoxRepresentation.h.

Definition at line 235 of file vtkBoxRepresentation.h.

Definition at line 238 of file vtkBoxRepresentation.h.

Definition at line 242 of file vtkBoxRepresentation.h.

Definition at line 243 of file vtkBoxRepresentation.h.

Definition at line 244 of file vtkBoxRepresentation.h.

Definition at line 245 of file vtkBoxRepresentation.h.

Definition at line 246 of file vtkBoxRepresentation.h.

Definition at line 247 of file vtkBoxRepresentation.h.

Definition at line 251 of file vtkBoxRepresentation.h.

Definition at line 252 of file vtkBoxRepresentation.h.

Definition at line 253 of file vtkBoxRepresentation.h.

Definition at line 268 of file vtkBoxRepresentation.h.

Definition at line 269 of file vtkBoxRepresentation.h.

Definition at line 270 of file vtkBoxRepresentation.h.


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

Generated on Wed Aug 24 11:29:48 2011 for VTK by  doxygen 1.5.6