vtkParallelopipedRepresentation Class Reference

#include <vtkParallelopipedRepresentation.h>

Inheritance diagram for vtkParallelopipedRepresentation:

Inheritance graph
[legend]
Collaboration diagram for vtkParallelopipedRepresentation:

Collaboration graph
[legend]

List of all members.


Detailed Description

Default representation for vtkParallelopipedWidget.

This class provides the default geometrical representation for vtkParallelopipedWidget. As a result of interactions of the widget, this representation can take on of the following shapes:

1) A parallelopiped. (8 handles, 6 faces)

2) Paralleopiped with a chair depression on any one handle. (A chair is a depression on one of the handles that carves inwards so as to allow the user to visualize cuts in the volume). (14 handles, 9 faces).

See also:
vtkParallelopipedWidget
Tests:
vtkParallelopipedRepresentation (Tests)

Definition at line 51 of file vtkParallelopipedRepresentation.h.

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

Public Types

enum  _InteractionState {
  Outside = 0, Inside, RequestResizeParallelopiped, RequestResizeParallelopipedAlongAnAxis,
  RequestChairMode, RequestTranslateParallelopiped, RequestScaleParallelopiped, RequestRotateParallelopiped,
  ResizingParallelopiped, ResizingParallelopipedAlongAnAxis, ChairMode, TranslatingParallelopiped,
  ScalingParallelopiped, RotatingParallelopiped
}

Public Member Functions

virtual void GetActors (vtkPropCollection *pc)
void GetBoundingPlanes (vtkPlaneCollection *pc)
void GetPolyData (vtkPolyData *pd)
virtual double * GetBounds ()
void SetHandleRepresentation (vtkHandleRepresentation *handle)
vtkHandleRepresentationGetHandleRepresentation (int index)
virtual void BuildRepresentation ()
virtual int ComputeInteractionState (int X, int Y, int modify=0)
virtual void Translate (double translation[3])
virtual void Translate (int X, int Y)
virtual void Scale (int X, int Y)
virtual void PositionHandles ()
virtual void PlaceWidget (double corners[8][3])
virtual void PlaceWidget (double bounds[6])
virtual void SetInteractionState (int)
virtual void SetHandleProperty (vtkProperty *)
virtual void SetHoveredHandleProperty (vtkProperty *)
virtual void SetSelectedHandleProperty (vtkProperty *)
virtual vtkPropertyGetHandleProperty ()
virtual vtkPropertyGetHoveredHandleProperty ()
virtual vtkPropertyGetSelectedHandleProperty ()
void HandlesOn ()
void HandlesOff ()
virtual vtkPropertyGetFaceProperty ()
virtual vtkPropertyGetSelectedFaceProperty ()
virtual vtkPropertyGetOutlineProperty ()
virtual vtkPropertyGetSelectedOutlineProperty ()
virtual void ReleaseGraphicsResources (vtkWindow *w)
virtual int RenderOverlay (vtkViewport *viewport)
virtual int RenderOpaqueGeometry (vtkViewport *viewport)
virtual void SetMinimumThickness (double)
virtual double GetMinimumThickness ()

Static Public Member Functions

static
vtkParallelopipedRepresentation
New ()

Protected Member Functions

 vtkParallelopipedRepresentation ()
 ~vtkParallelopipedRepresentation ()
void TranslatePoint (int n, const double motionVector[3])
void SetHandleHighlight (int handleIdx, vtkProperty *property)
void UpdateChairAtNode (int node)
void RemoveExistingChairs ()
void GetParallelopipedBoundingPlanes (vtkPlaneCollection *pc)
void DefinePlane (vtkPlane *, double p[3][3])
void DefinePlane (vtkPlane *, vtkIdType, vtkIdType, vtkIdType)
void SetFaceHighlight (vtkCellArray *face, vtkProperty *)
void HighlightAllFaces ()
void UnHighlightAllFaces ()

Protected Attributes

vtkActorHexActor
vtkPolyDataMapperHexMapper
vtkPolyDataHexPolyData
vtkPointsPoints
vtkActorHexFaceActor
vtkPolyDataMapperHexFaceMapper
vtkPolyDataHexFacePolyData
double LastEventPosition [2]
int LastResizeAxisIdx
vtkHandleRepresentationHandleRepresentation
vtkHandleRepresentation ** HandleRepresentations
int CurrentHandleIdx
int ChairHandleIdx
double InitialChairDepth
vtkPropertyHandleProperty
vtkPropertyHoveredHandleProperty
vtkPropertyFaceProperty
vtkPropertyOutlineProperty
vtkPropertySelectedHandleProperty
vtkPropertySelectedFaceProperty
vtkPropertySelectedOutlineProperty
vtkClosedSurfacePointPlacerChairPointPlacer
vtkParallelopipedTopology * Topology
double MinimumThickness
double AbsoluteMinimumThickness

Member Typedef Documentation

Standard methods for instances of this class.

Reimplemented from vtkWidgetRepresentation.

Definition at line 60 of file vtkParallelopipedRepresentation.h.


Member Enumeration Documentation

Enumerator:
Outside 
Inside 
RequestResizeParallelopiped 
RequestResizeParallelopipedAlongAnAxis 
RequestChairMode 
RequestTranslateParallelopiped 
RequestScaleParallelopiped 
RequestRotateParallelopiped 
ResizingParallelopiped 
ResizingParallelopipedAlongAnAxis 
ChairMode 
TranslatingParallelopiped 
ScalingParallelopiped 
RotatingParallelopiped 

Definition at line 150 of file vtkParallelopipedRepresentation.h.


Constructor & Destructor Documentation

vtkParallelopipedRepresentation::vtkParallelopipedRepresentation (  )  [protected]

vtkParallelopipedRepresentation::~vtkParallelopipedRepresentation (  )  [protected]


Member Function Documentation

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

Instantiate the class.

Reimplemented from vtkObject.

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

Standard methods for instances of this class.

Reimplemented from vtkWidgetRepresentation.

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

Standard methods for instances of this class.

Reimplemented from vtkWidgetRepresentation.

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

Standard methods for instances of this class.

Reimplemented from vtkWidgetRepresentation.

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

Standard methods for instances of this class.

Reimplemented from vtkWidgetRepresentation.

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

Standard methods for instances of this class.

Reimplemented from vtkWidgetRepresentation.

virtual void vtkParallelopipedRepresentation::GetActors ( vtkPropCollection pc  )  [virtual]

Methods to satisfy the superclass.

Reimplemented from vtkWidgetRepresentation.

virtual void vtkParallelopipedRepresentation::PlaceWidget ( double  corners[8][3]  )  [virtual]

Place the widget in the scene. You can use either of the two APIs : 1) PlaceWidget( double bounds[6] ) Creates a cuboid conforming to the said bounds. 2) PlaceWidget( double corners[8][3] ) Creates a parallelopiped with corners specified. The order in which corners are specified must obey the following rule: Corner 0 - 1 - 2 - 3 - 0 forms a face Corner 4 - 5 - 6 - 7 - 4 forms a face Corner 0 - 4 - 5

  • 1 - 0 forms a face Corner 1 - 5 - 6 - 2 - 1 forms a face Corner 2
  • 6 - 7 - 3 - 2 forms a face Corner 3 - 7 - 4 - 0 - 3 forms a face

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

Place the widget in the scene. You can use either of the two APIs : 1) PlaceWidget( double bounds[6] ) Creates a cuboid conforming to the said bounds. 2) PlaceWidget( double corners[8][3] ) Creates a parallelopiped with corners specified. The order in which corners are specified must obey the following rule: Corner 0 - 1 - 2 - 3 - 0 forms a face Corner 4 - 5 - 6 - 7 - 4 forms a face Corner 0 - 4 - 5

  • 1 - 0 forms a face Corner 1 - 5 - 6 - 2 - 1 forms a face Corner 2
  • 6 - 7 - 3 - 2 forms a face Corner 3 - 7 - 4 - 0 - 3 forms a face

virtual void vtkParallelopipedRepresentation::SetInteractionState ( int   )  [virtual]

The interaction state may be set from a widget (e.g., PointWidget) or other object. This controls how the interaction with the widget proceeds.

void vtkParallelopipedRepresentation::GetBoundingPlanes ( vtkPlaneCollection pc  ) 

Get the bounding planes of the object. The first 6 planes will be bounding planes of the parallelopiped. If in chair mode, three additional planes will be present. The last three planes will be those of the chair. The normals of all the planes will point into the object.

void vtkParallelopipedRepresentation::GetPolyData ( vtkPolyData pd  ) 

The parallelopiped polydata.

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

The parallelopiped polydata.

Reimplemented from vtkWidgetRepresentation.

virtual void vtkParallelopipedRepresentation::SetHandleProperty ( vtkProperty  )  [virtual]

Set/Get the handle properties.

virtual void vtkParallelopipedRepresentation::SetHoveredHandleProperty ( vtkProperty  )  [virtual]

Set/Get the handle properties.

virtual void vtkParallelopipedRepresentation::SetSelectedHandleProperty ( vtkProperty  )  [virtual]

Set/Get the handle properties.

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

Set/Get the handle properties.

virtual vtkProperty* vtkParallelopipedRepresentation::GetHoveredHandleProperty (  )  [virtual]

Set/Get the handle properties.

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

Set/Get the handle properties.

void vtkParallelopipedRepresentation::SetHandleRepresentation ( vtkHandleRepresentation handle  ) 

vtkHandleRepresentation* vtkParallelopipedRepresentation::GetHandleRepresentation ( int  index  ) 

void vtkParallelopipedRepresentation::HandlesOn (  ) 

Turns the visibility of the handles on/off. Sometimes they may get in the way of visualization.

void vtkParallelopipedRepresentation::HandlesOff (  ) 

Turns the visibility of the handles on/off. Sometimes they may get in the way of visualization.

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

Get the face properties. When a face is being translated, the face gets highlighted with the SelectedFaceProperty.

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

Get the face properties. When a face is being translated, the face gets highlighted with the SelectedFaceProperty.

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

Get the outline properties. These are the properties with which the parallelopiped wireframe is rendered.

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

Get the outline properties. These are the properties with which the parallelopiped wireframe is rendered.

virtual void vtkParallelopipedRepresentation::BuildRepresentation (  )  [virtual]

This actually constructs the geometry of the widget from the various data parameters.

Implements vtkWidgetRepresentation.

virtual void vtkParallelopipedRepresentation::ReleaseGraphicsResources ( vtkWindow w  )  [virtual]

Methods required by vtkProp superclass.

Reimplemented from vtkWidgetRepresentation.

virtual int vtkParallelopipedRepresentation::RenderOverlay ( vtkViewport viewport  )  [virtual]

Methods required by vtkProp superclass.

Reimplemented from vtkProp.

virtual int vtkParallelopipedRepresentation::RenderOpaqueGeometry ( vtkViewport viewport  )  [virtual]

Methods required by vtkProp superclass.

Reimplemented from vtkProp.

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

Given and x-y display coordinate, compute the interaction state of the widget.

Reimplemented from vtkWidgetRepresentation.

virtual void vtkParallelopipedRepresentation::Translate ( double  translation[3]  )  [virtual]

virtual void vtkParallelopipedRepresentation::Translate ( int  X,
int  Y 
) [virtual]

virtual void vtkParallelopipedRepresentation::Scale ( int  X,
int  Y 
) [virtual]

virtual void vtkParallelopipedRepresentation::PositionHandles (  )  [virtual]

Synchronize the parallelopiped handle positions with the Polygonal datastructure.

virtual void vtkParallelopipedRepresentation::SetMinimumThickness ( double   )  [virtual]

Minimum thickness for the parallelopiped. User interactions cannot make any individual axis of the parallopiped thinner than this value. Default is 0.05 expressed as a fraction of the diagonal of the bounding box used in the PlaceWidget() invocation.

virtual double vtkParallelopipedRepresentation::GetMinimumThickness (  )  [virtual]

Minimum thickness for the parallelopiped. User interactions cannot make any individual axis of the parallopiped thinner than this value. Default is 0.05 expressed as a fraction of the diagonal of the bounding box used in the PlaceWidget() invocation.

void vtkParallelopipedRepresentation::TranslatePoint ( int  n,
const double  motionVector[3] 
) [protected]

Translate the nth PtId (0 <= n <= 15) by the specified amount.

void vtkParallelopipedRepresentation::SetHandleHighlight ( int  handleIdx,
vtkProperty property 
) [protected]

Set the highlight state of a handle. If handleIdx is -1, the property is applied to all handles.

void vtkParallelopipedRepresentation::SetFaceHighlight ( vtkCellArray face,
vtkProperty  
) [protected]

Highlight face defined by the supplied ptids with the specified property.

void vtkParallelopipedRepresentation::HighlightAllFaces (  )  [protected]

Highlight face defined by the supplied ptids with the specified property.

void vtkParallelopipedRepresentation::UnHighlightAllFaces (  )  [protected]

Highlight face defined by the supplied ptids with the specified property.

void vtkParallelopipedRepresentation::UpdateChairAtNode ( int  node  )  [protected]

void vtkParallelopipedRepresentation::RemoveExistingChairs (  )  [protected]

void vtkParallelopipedRepresentation::GetParallelopipedBoundingPlanes ( vtkPlaneCollection pc  )  [protected]

void vtkParallelopipedRepresentation::DefinePlane ( vtkPlane ,
double  p[3][3] 
) [protected]

void vtkParallelopipedRepresentation::DefinePlane ( vtkPlane ,
vtkIdType  ,
vtkIdType  ,
vtkIdType   
) [protected]


Member Data Documentation

Definition at line 230 of file vtkParallelopipedRepresentation.h.

Definition at line 231 of file vtkParallelopipedRepresentation.h.

Definition at line 232 of file vtkParallelopipedRepresentation.h.

Definition at line 233 of file vtkParallelopipedRepresentation.h.

Definition at line 234 of file vtkParallelopipedRepresentation.h.

Definition at line 235 of file vtkParallelopipedRepresentation.h.

Definition at line 236 of file vtkParallelopipedRepresentation.h.

Definition at line 238 of file vtkParallelopipedRepresentation.h.

Definition at line 241 of file vtkParallelopipedRepresentation.h.

Definition at line 243 of file vtkParallelopipedRepresentation.h.

Definition at line 244 of file vtkParallelopipedRepresentation.h.

Definition at line 245 of file vtkParallelopipedRepresentation.h.

Definition at line 246 of file vtkParallelopipedRepresentation.h.

Definition at line 251 of file vtkParallelopipedRepresentation.h.

Definition at line 253 of file vtkParallelopipedRepresentation.h.

Definition at line 254 of file vtkParallelopipedRepresentation.h.

Definition at line 255 of file vtkParallelopipedRepresentation.h.

Definition at line 256 of file vtkParallelopipedRepresentation.h.

Definition at line 257 of file vtkParallelopipedRepresentation.h.

Definition at line 258 of file vtkParallelopipedRepresentation.h.

Definition at line 259 of file vtkParallelopipedRepresentation.h.

Definition at line 260 of file vtkParallelopipedRepresentation.h.

vtkParallelopipedTopology* vtkParallelopipedRepresentation::Topology [protected]

Definition at line 261 of file vtkParallelopipedRepresentation.h.

Definition at line 262 of file vtkParallelopipedRepresentation.h.

Definition at line 263 of file vtkParallelopipedRepresentation.h.


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

Generated on Sat Dec 27 13:40:53 2008 for VTK by  doxygen 1.5.6