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

#include <vtkBoxRepresentation.h>

Inheritance diagram for vtkBoxRepresentation:

Collaboration diagram for vtkBoxRepresentation:

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

typedef vtkWidgetRepresentation	Superclass
	Standard methods for the class. More...

Public Types inherited from vtkWidgetRepresentation
typedef vtkProp	Superclass
	Standard methods for instances of this class. More...

Public Types inherited from vtkProp
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...

vtkBoxRepresentation *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

void	GetPlanes (vtkPlanes *planes)
	Get the planes describing the implicit function defined by the box widget. More...

virtual void	SetInsideOut (int)
	Set/Get the InsideOut flag. More...

virtual int	GetInsideOut ()

virtual void	InsideOutOn ()

virtual void	InsideOutOff ()

virtual void	GetTransform (vtkTransform *t)
	Retrieve a linear transform characterizing the transformation of the box. More...

virtual void	SetTransform (vtkTransform *t)
	Set the position, scale and orientation of the box widget using the transform specified. More...

void	GetPolyData (vtkPolyData *pd)
	Grab the polydata (including points) that define the box widget. More...

virtual vtkProperty *	GetHandleProperty ()
	Get the handle properties (the little balls are the handles). More...

virtual vtkProperty *	GetSelectedHandleProperty ()

virtual vtkProperty *	GetFaceProperty ()
	Get the face properties (the faces of the box). More...

virtual vtkProperty *	GetSelectedFaceProperty ()

virtual vtkProperty *	GetOutlineProperty ()
	Get the outline properties (the outline of the box). More...

virtual vtkProperty *	GetSelectedOutlineProperty ()

void	SetOutlineFaceWires (int)
	Control the representation of the outline. More...

virtual int	GetOutlineFaceWires ()

void	OutlineFaceWiresOn ()

void	OutlineFaceWiresOff ()

void	SetOutlineCursorWires (int)
	Control the representation of the outline. More...

virtual int	GetOutlineCursorWires ()

void	OutlineCursorWiresOn ()

void	OutlineCursorWiresOff ()

virtual void	HandlesOn ()
	Switches handles (the spheres) on or off by manipulating the underlying actor visibility. More...

virtual void	HandlesOff ()

virtual void	PlaceWidget (double bounds[6])
	These are methods that satisfy vtkWidgetRepresentation's API. More...

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 ()
	Methods to make this class behave as a vtkProp. More...

virtual void	ReleaseGraphicsResources (vtkWindow *)
	Methods supporting, and required by, the rendering process. 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	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...

void	SetInteractionState (int state)
	The interaction state may be set from a widget (e.g., vtkBoxWidget2) or other object. More...

Public Member Functions inherited from vtkWidgetRepresentation
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...

Public Member Functions inherited from vtkProp
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)

Public Member Functions inherited from vtkObject
	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)

Public Member Functions inherited from vtkObjectBase
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 vtkBoxRepresentation *	New ()
	Instantiate the class. More...

static int	IsTypeOf (const char *type)

static vtkBoxRepresentation *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkWidgetRepresentation
static int	IsTypeOf (const char *type)

static vtkWidgetRepresentation *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkProp
static int	IsTypeOf (const char *type)

static vtkProp *	SafeDownCast (vtkObjectBase *o)

static vtkInformationIntegerKey *	GeneralTextureUnit ()
	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 Public Member Functions inherited from vtkObject
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 Public Member Functions inherited from vtkObjectBase
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

	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	RegisterPickers ()
	Register internal Pickers in the Picking Manager. More...

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 Member Functions inherited from vtkWidgetRepresentation
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])

Protected Member Functions inherited from vtkProp
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkProp ()

	~vtkProp ()

Protected Member Functions inherited from vtkObject
	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 ()

Protected Member Functions inherited from vtkObjectBase
	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
double	LastEventPosition [3]

vtkActor *	HexActor

vtkPolyDataMapper *	HexMapper

vtkPolyData *	HexPolyData

vtkPoints *	Points

double	N [6][3]

vtkActor *	HexFace

vtkPolyDataMapper *	HexFaceMapper

vtkPolyData *	HexFacePolyData

vtkActor **	Handle

vtkPolyDataMapper **	HandleMapper

vtkSphereSource **	HandleGeometry

vtkActor *	HexOutline

vtkPolyDataMapper *	OutlineMapper

vtkPolyData *	OutlinePolyData

vtkCellPicker *	HandlePicker

vtkCellPicker *	HexPicker

vtkActor *	CurrentHandle

int	CurrentHexFace

vtkCellPicker *	LastPicker

vtkTransform *	Transform

vtkBox *	BoundingBox

vtkProperty *	HandleProperty

vtkProperty *	SelectedHandleProperty

vtkProperty *	FaceProperty

vtkProperty *	SelectedFaceProperty

vtkProperty *	OutlineProperty

vtkProperty *	SelectedOutlineProperty

int	InsideOut

int	OutlineFaceWires

int	OutlineCursorWires

vtkPoints *	PlanePoints

vtkDoubleArray *	PlaneNormals

vtkMatrix4x4 *	Matrix

Protected Attributes inherited from vtkWidgetRepresentation
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

Protected Attributes inherited from vtkProp
int	Visibility

int	Pickable

int	Dragable

bool	UseBounds

double	AllocatedRenderTime

double	EstimatedRenderTime

double	SavedEstimatedRenderTime

double	RenderTimeMultiplier

int	NumberOfConsumers

vtkObject **	Consumers

vtkAssemblyPaths *	Paths

vtkInformation *	PropertyKeys

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

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 62 of file vtkBoxRepresentation.h.

Member Typedef Documentation

◆ Superclass

typedef vtkWidgetRepresentation vtkBoxRepresentation::Superclass

Standard methods for the class.

Definition at line 74 of file vtkBoxRepresentation.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enumerator
Outside
MoveF0
MoveF1
MoveF2
MoveF3
MoveF4
MoveF5
Translating
Rotating
Scaling

Definition at line 214 of file vtkBoxRepresentation.h.

Constructor & Destructor Documentation

◆ vtkBoxRepresentation()

vtkBoxRepresentation::vtkBoxRepresentation ( )

protected

◆ ~vtkBoxRepresentation()

vtkBoxRepresentation::~vtkBoxRepresentation ( )

protected

Member Function Documentation

◆ New()

static vtkBoxRepresentation * vtkBoxRepresentation::New ( )

static

Instantiate the class.

◆ IsTypeOf()

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

static

◆ IsA()

virtual int vtkBoxRepresentation::IsA ( const char * name )

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 vtkWidgetRepresentation.

◆ SafeDownCast()

static vtkBoxRepresentation * vtkBoxRepresentation::SafeDownCast ( vtkObjectBase * o )

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkBoxRepresentation::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkWidgetRepresentation.

◆ NewInstance()

vtkBoxRepresentation * vtkBoxRepresentation::NewInstance ( ) const

◆ PrintSelf()

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

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.

◆ GetPlanes()

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.)

◆ SetInsideOut()

virtual void vtkBoxRepresentation::SetInsideOut ( int )

virtual

Set/Get the InsideOut flag.

This data member 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.

◆ GetInsideOut()

virtual int vtkBoxRepresentation::GetInsideOut ( )

virtual

◆ InsideOutOn()

virtual void vtkBoxRepresentation::InsideOutOn ( )

virtual

◆ InsideOutOff()

virtual void vtkBoxRepresentation::InsideOutOff ( )

virtual

◆ GetTransform()

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).

◆ SetTransform()

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).

◆ GetPolyData()

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.

◆ GetHandleProperty()

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.

◆ GetSelectedHandleProperty()

virtual vtkProperty * vtkBoxRepresentation::GetSelectedHandleProperty ( )

virtual

◆ GetFaceProperty()

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.

◆ GetSelectedFaceProperty()

virtual vtkProperty * vtkBoxRepresentation::GetSelectedFaceProperty ( )

virtual

◆ GetOutlineProperty()

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.

◆ GetSelectedOutlineProperty()

virtual vtkProperty * vtkBoxRepresentation::GetSelectedOutlineProperty ( )

virtual

◆ SetOutlineFaceWires()

void vtkBoxRepresentation::SetOutlineFaceWires ( int )

Control the representation of the outline.

This flag enables face wires. By default face wires are off.

◆ GetOutlineFaceWires()

virtual int vtkBoxRepresentation::GetOutlineFaceWires ( )

virtual

◆ OutlineFaceWiresOn()

void vtkBoxRepresentation::OutlineFaceWiresOn ( )

inline

Definition at line 166 of file vtkBoxRepresentation.h.

◆ OutlineFaceWiresOff()

void vtkBoxRepresentation::OutlineFaceWiresOff ( )

inline

Definition at line 167 of file vtkBoxRepresentation.h.

◆ SetOutlineCursorWires()

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.

◆ GetOutlineCursorWires()

virtual int vtkBoxRepresentation::GetOutlineCursorWires ( )

virtual

◆ OutlineCursorWiresOn()

void vtkBoxRepresentation::OutlineCursorWiresOn ( )

inline

Definition at line 178 of file vtkBoxRepresentation.h.

◆ OutlineCursorWiresOff()

void vtkBoxRepresentation::OutlineCursorWiresOff ( )

inline

Definition at line 179 of file vtkBoxRepresentation.h.

◆ HandlesOn()

virtual void vtkBoxRepresentation::HandlesOn ( )

virtual

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

◆ HandlesOff()

virtual void vtkBoxRepresentation::HandlesOff ( )

virtual

◆ PlaceWidget()

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

virtual

These are methods that satisfy vtkWidgetRepresentation's API.

◆ BuildRepresentation()

virtual void vtkBoxRepresentation::BuildRepresentation ( )

virtual

Implements vtkWidgetRepresentation.

◆ ComputeInteractionState()

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

virtual

Reimplemented from vtkWidgetRepresentation.

◆ StartWidgetInteraction()

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

virtual

Reimplemented from vtkWidgetRepresentation.

◆ WidgetInteraction()

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

virtual

Reimplemented from vtkWidgetRepresentation.

◆ GetBounds()

virtual double * vtkBoxRepresentation::GetBounds ( void )

virtual

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 vtkWidgetRepresentation.

◆ ReleaseGraphicsResources()

virtual void vtkBoxRepresentation::ReleaseGraphicsResources ( vtkWindow * )

virtual

Methods supporting, and required by, the rendering process.

Reimplemented from vtkWidgetRepresentation.

◆ RenderOpaqueGeometry()

virtual int vtkBoxRepresentation::RenderOpaqueGeometry ( vtkViewport * )

virtual

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.

There are four key render methods in vtk and they correspond to four different points in the rendering cycle. Any given prop may implement one or more of these methods. The first method is intended for rendering all opaque geometry. The second method is intended for rendering all translucent polygonal geometry. The third one is intended for rendering all translucent volumetric geometry. Most of the volume rendering mappers draw their results during this third method. The last method is to render any 2D annotation or overlays. Each of these methods return an integer value indicating whether or not this render method was applied to this data.

Reimplemented from vtkProp.

◆ RenderTranslucentPolygonalGeometry()

virtual int vtkBoxRepresentation::RenderTranslucentPolygonalGeometry ( vtkViewport * )

virtual

Reimplemented from vtkProp.

◆ HasTranslucentPolygonalGeometry()

virtual int vtkBoxRepresentation::HasTranslucentPolygonalGeometry ( )

virtual

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 vtkWidgetRepresentation.

◆ SetInteractionState()

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.

◆ PositionHandles()

virtual void vtkBoxRepresentation::PositionHandles ( )

protectedvirtual

◆ HighlightHandle()

int vtkBoxRepresentation::HighlightHandle ( vtkProp * prop )

protected

◆ HighlightFace()

void vtkBoxRepresentation::HighlightFace ( int cellId )

protected

◆ HighlightOutline()

void vtkBoxRepresentation::HighlightOutline ( int highlight )

protected

◆ ComputeNormals()

virtual void vtkBoxRepresentation::ComputeNormals ( )

protectedvirtual

◆ SizeHandles()

virtual void vtkBoxRepresentation::SizeHandles ( )

protectedvirtual

◆ RegisterPickers()

virtual void vtkBoxRepresentation::RegisterPickers ( )

protectedvirtual

Register internal Pickers in the Picking Manager.

Must be reimplemented by concrete widget representations to register their pickers.

Reimplemented from vtkWidgetRepresentation.

◆ CreateDefaultProperties()

virtual void vtkBoxRepresentation::CreateDefaultProperties ( )

protectedvirtual

◆ GenerateOutline()

void vtkBoxRepresentation::GenerateOutline ( )

protected

◆ Translate()

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

protectedvirtual

◆ Scale()

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

protectedvirtual

◆ Rotate()

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

protectedvirtual

◆ MovePlusXFace()

void vtkBoxRepresentation::MovePlusXFace	(	double *	p1,
		double *	p2
	)

protected

◆ MoveMinusXFace()

void vtkBoxRepresentation::MoveMinusXFace	(	double *	p1,
		double *	p2
	)

protected

◆ MovePlusYFace()

void vtkBoxRepresentation::MovePlusYFace	(	double *	p1,
		double *	p2
	)

protected

◆ MoveMinusYFace()

void vtkBoxRepresentation::MoveMinusYFace	(	double *	p1,
		double *	p2
	)

protected

◆ MovePlusZFace()

void vtkBoxRepresentation::MovePlusZFace	(	double *	p1,
		double *	p2
	)

protected

◆ MoveMinusZFace()

void vtkBoxRepresentation::MoveMinusZFace	(	double *	p1,
		double *	p2
	)

protected

◆ MoveFace()

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

protected

◆ GetDirection()

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

protected

Member Data Documentation

◆ LastEventPosition

double vtkBoxRepresentation::LastEventPosition[3]

protected

Definition at line 232 of file vtkBoxRepresentation.h.

◆ HexActor

vtkActor* vtkBoxRepresentation::HexActor

protected

Definition at line 235 of file vtkBoxRepresentation.h.

◆ HexMapper

vtkPolyDataMapper* vtkBoxRepresentation::HexMapper

protected

Definition at line 236 of file vtkBoxRepresentation.h.

◆ HexPolyData

vtkPolyData* vtkBoxRepresentation::HexPolyData

protected

Definition at line 237 of file vtkBoxRepresentation.h.

◆ Points

vtkPoints* vtkBoxRepresentation::Points

protected

Definition at line 238 of file vtkBoxRepresentation.h.

◆ N

double vtkBoxRepresentation::N[6][3]

protected

Definition at line 239 of file vtkBoxRepresentation.h.

◆ HexFace

vtkActor* vtkBoxRepresentation::HexFace

protected

Definition at line 242 of file vtkBoxRepresentation.h.

◆ HexFaceMapper

vtkPolyDataMapper* vtkBoxRepresentation::HexFaceMapper

protected

Definition at line 243 of file vtkBoxRepresentation.h.

◆ HexFacePolyData

vtkPolyData* vtkBoxRepresentation::HexFacePolyData

protected

Definition at line 244 of file vtkBoxRepresentation.h.

◆ Handle

vtkActor** vtkBoxRepresentation::Handle

protected

Definition at line 247 of file vtkBoxRepresentation.h.

◆ HandleMapper

vtkPolyDataMapper** vtkBoxRepresentation::HandleMapper

protected

Definition at line 248 of file vtkBoxRepresentation.h.

◆ HandleGeometry

vtkSphereSource** vtkBoxRepresentation::HandleGeometry

protected

Definition at line 249 of file vtkBoxRepresentation.h.

◆ HexOutline

vtkActor* vtkBoxRepresentation::HexOutline

protected

Definition at line 258 of file vtkBoxRepresentation.h.

◆ OutlineMapper

vtkPolyDataMapper* vtkBoxRepresentation::OutlineMapper

protected

Definition at line 259 of file vtkBoxRepresentation.h.

◆ OutlinePolyData

vtkPolyData* vtkBoxRepresentation::OutlinePolyData

protected

Definition at line 260 of file vtkBoxRepresentation.h.

◆ HandlePicker

vtkCellPicker* vtkBoxRepresentation::HandlePicker

protected

Definition at line 263 of file vtkBoxRepresentation.h.

◆ HexPicker

vtkCellPicker* vtkBoxRepresentation::HexPicker

protected

Definition at line 264 of file vtkBoxRepresentation.h.

◆ CurrentHandle

vtkActor* vtkBoxRepresentation::CurrentHandle

protected

Definition at line 265 of file vtkBoxRepresentation.h.

◆ CurrentHexFace

int vtkBoxRepresentation::CurrentHexFace

protected

Definition at line 266 of file vtkBoxRepresentation.h.

◆ LastPicker

vtkCellPicker* vtkBoxRepresentation::LastPicker

protected

Definition at line 267 of file vtkBoxRepresentation.h.

◆ Transform

vtkTransform* vtkBoxRepresentation::Transform

protected

Definition at line 273 of file vtkBoxRepresentation.h.

◆ BoundingBox

vtkBox* vtkBoxRepresentation::BoundingBox

protected

Definition at line 276 of file vtkBoxRepresentation.h.

◆ HandleProperty

vtkProperty* vtkBoxRepresentation::HandleProperty

protected

Definition at line 280 of file vtkBoxRepresentation.h.

◆ SelectedHandleProperty

vtkProperty* vtkBoxRepresentation::SelectedHandleProperty

protected

Definition at line 281 of file vtkBoxRepresentation.h.

◆ FaceProperty

vtkProperty* vtkBoxRepresentation::FaceProperty

protected

Definition at line 282 of file vtkBoxRepresentation.h.

◆ SelectedFaceProperty

vtkProperty* vtkBoxRepresentation::SelectedFaceProperty

protected

Definition at line 283 of file vtkBoxRepresentation.h.

◆ OutlineProperty

vtkProperty* vtkBoxRepresentation::OutlineProperty

protected

Definition at line 284 of file vtkBoxRepresentation.h.

◆ SelectedOutlineProperty

vtkProperty* vtkBoxRepresentation::SelectedOutlineProperty

protected

Definition at line 285 of file vtkBoxRepresentation.h.

◆ InsideOut

int vtkBoxRepresentation::InsideOut

protected

Definition at line 289 of file vtkBoxRepresentation.h.

◆ OutlineFaceWires

int vtkBoxRepresentation::OutlineFaceWires

protected

Definition at line 290 of file vtkBoxRepresentation.h.

◆ OutlineCursorWires

int vtkBoxRepresentation::OutlineCursorWires

protected

Definition at line 291 of file vtkBoxRepresentation.h.

◆ PlanePoints

vtkPoints* vtkBoxRepresentation::PlanePoints

protected

Definition at line 306 of file vtkBoxRepresentation.h.

◆ PlaneNormals

vtkDoubleArray* vtkBoxRepresentation::PlaneNormals

protected

Definition at line 307 of file vtkBoxRepresentation.h.

◆ Matrix

vtkMatrix4x4* vtkBoxRepresentation::Matrix

protected

Definition at line 308 of file vtkBoxRepresentation.h.

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

dox/Interaction/Widgets/vtkBoxRepresentation.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ Superclass

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ vtkBoxRepresentation()

◆ ~vtkBoxRepresentation()

Member Function Documentation

◆ New()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ GetPlanes()

◆ SetInsideOut()

◆ GetInsideOut()

◆ InsideOutOn()

◆ InsideOutOff()

◆ GetTransform()

◆ SetTransform()

◆ GetPolyData()

◆ GetHandleProperty()

◆ GetSelectedHandleProperty()

◆ GetFaceProperty()

◆ GetSelectedFaceProperty()

◆ GetOutlineProperty()

◆ GetSelectedOutlineProperty()

◆ SetOutlineFaceWires()

◆ GetOutlineFaceWires()

◆ OutlineFaceWiresOn()

◆ OutlineFaceWiresOff()

◆ SetOutlineCursorWires()

◆ GetOutlineCursorWires()

◆ OutlineCursorWiresOn()

◆ OutlineCursorWiresOff()

◆ HandlesOn()

◆ HandlesOff()

◆ PlaceWidget()

◆ BuildRepresentation()

◆ ComputeInteractionState()

◆ StartWidgetInteraction()

◆ WidgetInteraction()

◆ GetBounds()

◆ ReleaseGraphicsResources()

◆ RenderOpaqueGeometry()

◆ RenderTranslucentPolygonalGeometry()

◆ HasTranslucentPolygonalGeometry()

◆ SetInteractionState()

◆ PositionHandles()

◆ HighlightHandle()

◆ HighlightFace()

◆ HighlightOutline()

◆ ComputeNormals()

◆ SizeHandles()

◆ RegisterPickers()

◆ CreateDefaultProperties()

◆ GenerateOutline()

◆ Translate()

◆ Scale()

◆ Rotate()

◆ MovePlusXFace()

◆ MoveMinusXFace()

◆ MovePlusYFace()

◆ MoveMinusYFace()

◆ MovePlusZFace()

◆ MoveMinusZFace()

◆ MoveFace()

◆ GetDirection()

Member Data Documentation

◆ LastEventPosition

◆ HexActor

◆ HexMapper