represent the vtkBiDimensionalWidget More...

#include <vtkBiDimensionalRepresentation2D.h>

Inheritance diagram for vtkBiDimensionalRepresentation2D:

Collaboration diagram for vtkBiDimensionalRepresentation2D:

Public Types
enum	{ Outside = 0, NearP1, NearP2, NearP3, NearP4, OnL1Inner, OnL1Outer, OnL2Inner, OnL2Outer, OnCenter }

typedef vtkBiDimensionalRepresentation	Superclass
	Standard VTK methods. More...

Public Types inherited from vtkBiDimensionalRepresentation
enum	{ Outside = 0, NearP1, NearP2, NearP3, NearP4, OnL1Inner, OnL1Outer, OnL2Inner, OnL2Outer, OnCenter }

typedef vtkWidgetRepresentation	Superclass
	Standard VTK methods. More...

Public Types inherited from vtkWidgetRepresentation
enum	Axis { NONE = -1, XAxis = 0, YAxis = 1, ZAxis = 2 }
	Axis labels. More...

typedef vtkProp	Superclass
	Standard methods for instances of this class. More...

Public Types inherited from vtkProp
typedef vtkObject	Superclass

Public Member Functions
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

vtkBiDimensionalRepresentation2D *	NewInstance () const

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

virtual vtkProperty2D *	GetLineProperty ()
	Retrieve the property used to control the appearance of the two orthogonal lines. More...

virtual vtkProperty2D *	GetSelectedLineProperty ()

virtual vtkTextProperty *	GetTextProperty ()
	Retrieve the property used to control the appearance of the text labels. More...

void	BuildRepresentation () override
	These are methods that satisfy vtkWidgetRepresentation's API. More...

int	ComputeInteractionState (int X, int Y, int modify=0) override

void	StartWidgetDefinition (double e[2]) override
	These are methods that satisfy vtkWidgetRepresentation's API. More...

void	Point2WidgetInteraction (double e[2]) override

void	Point3WidgetInteraction (double e[2]) override

void	StartWidgetManipulation (double e[2]) override

void	WidgetInteraction (double e[2]) override

void	Highlight (int highlightOn) override

void	ReleaseGraphicsResources (vtkWindow *w) override
	Methods required by vtkProp superclass. More...

int	RenderOverlay (vtkViewport *viewport) override

char *	GetLabelText () override
	Get the text shown in the widget's label. More...

double *	GetLabelPosition () override
	Get the position of the widget's label in display coordinates. More...

void	GetLabelPosition (double pos[3]) override

void	GetWorldLabelPosition (double pos[3]) override

Public Member Functions inherited from vtkBiDimensionalRepresentation
vtkBiDimensionalRepresentation *	NewInstance () const

virtual void	SetPoint1WorldPosition (double pos[3])
	Methods to Set/Get the coordinates of the four points defining this representation. More...

virtual void	SetPoint2WorldPosition (double pos[3])

virtual void	SetPoint3WorldPosition (double pos[3])

virtual void	SetPoint4WorldPosition (double pos[3])

virtual void	GetPoint1WorldPosition (double pos[3])

virtual void	GetPoint2WorldPosition (double pos[3])

virtual void	GetPoint3WorldPosition (double pos[3])

virtual void	GetPoint4WorldPosition (double pos[3])

virtual void	SetPoint1DisplayPosition (double pos[3])

virtual void	SetPoint2DisplayPosition (double pos[3])

virtual void	SetPoint3DisplayPosition (double pos[3])

virtual void	SetPoint4DisplayPosition (double pos[3])

virtual void	GetPoint1DisplayPosition (double pos[3])

virtual void	GetPoint2DisplayPosition (double pos[3])

virtual void	GetPoint3DisplayPosition (double pos[3])

virtual void	GetPoint4DisplayPosition (double pos[3])

virtual vtkHandleRepresentation *	GetPoint1Representation ()
	Set/Get the handle representations used within the vtkBiDimensionalRepresentation2D. More...

virtual vtkHandleRepresentation *	GetPoint2Representation ()

virtual vtkHandleRepresentation *	GetPoint3Representation ()

virtual vtkHandleRepresentation *	GetPoint4Representation ()

virtual void	SetLine1Visibility (vtkTypeBool)
	Special methods for turning off the lines that define the bi-dimensional measure. More...

virtual vtkTypeBool	GetLine1Visibility ()

virtual void	Line1VisibilityOn ()

virtual void	Line1VisibilityOff ()

virtual void	SetLine2Visibility (vtkTypeBool)

virtual vtkTypeBool	GetLine2Visibility ()

virtual void	Line2VisibilityOn ()

virtual void	Line2VisibilityOff ()

void	SetHandleRepresentation (vtkHandleRepresentation *handle)
	This method is used to specify the type of handle representation to use for the four internal vtkHandleRepresentations within vtkBiDimensionalRepresentation. More...

virtual void	InstantiateHandleRepresentation ()

virtual void	SetTolerance (int)
	The tolerance representing the distance to the representation (in pixels) in which the cursor is considered near enough to the representation to be active. More...

virtual int	GetTolerance ()

virtual double	GetLength1 ()
	Return the length of the line defined by (Point1,Point2). More...

virtual double	GetLength2 ()
	Return the length of the line defined by (Point3,Point4). More...

virtual void	SetLabelFormat (const char *)
	Specify the format to use for labelling the distance. More...

virtual char *	GetLabelFormat ()

virtual void	SetShowLabelAboveWidget (vtkTypeBool)
	Toggle whether to display the label above or below the widget. More...

virtual vtkTypeBool	GetShowLabelAboveWidget ()

virtual void	ShowLabelAboveWidgetOn ()

virtual void	ShowLabelAboveWidgetOff ()

void	SetID (vtkIdType id)
	Set/get the id to display in the label. More...

virtual vtkIdType	GetID ()

Public Member Functions inherited from vtkWidgetRepresentation
vtkWidgetRepresentation *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	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 ()

void	SetPickingManaged (bool managed)

virtual bool	GetPickingManaged ()

virtual void	SetRenderer (vtkRenderer *ren)
	Subclasses of vtkWidgetRepresentation must implement these methods. More...

virtual vtkRenderer *	GetRenderer ()

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	EndWidgetInteraction (double newEventPos[2])

virtual int	GetInteractionState ()

virtual void	Highlight (int vtkNotUsed(highlightOn))

virtual void	StartComplexInteraction (vtkRenderWindowInteractor , vtkAbstractWidget , unsigned long, void *)

virtual void	ComplexInteraction (vtkRenderWindowInteractor , vtkAbstractWidget , unsigned long, void *)

virtual void	EndComplexInteraction (vtkRenderWindowInteractor , vtkAbstractWidget , unsigned long, void *)

virtual int	ComputeComplexInteractionState (vtkRenderWindowInteractor iren, vtkAbstractWidget widget, unsigned long event, void *callData, int modify=0)

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 vtkTypeBool	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 (vtkTypeBool)

virtual void	NeedToRenderOn ()

virtual void	NeedToRenderOff ()

double *	GetBounds () override
	Methods to make this class behave as a vtkProp. More...

void	ShallowCopy (vtkProp *prop) override
	Shallow copy of this vtkProp. More...

void	GetActors (vtkPropCollection *) override
	For some exporters and other other operations we must be able to collect all the actors or volumes. More...

void	GetActors2D (vtkPropCollection *) override

void	GetVolumes (vtkPropCollection *) override

void	ReleaseGraphicsResources (vtkWindow *) override
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Release any graphics resources that are being consumed by this actor. More...

int	RenderOverlay (vtkViewport *vtkNotUsed(viewport)) override

int	RenderOpaqueGeometry (vtkViewport *vtkNotUsed(viewport)) override

int	RenderTranslucentPolygonalGeometry (vtkViewport *vtkNotUsed(viewport)) override

int	RenderVolumetricGeometry (vtkViewport *vtkNotUsed(viewport)) override

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

virtual void	UnRegisterPickers ()
	Unregister internal pickers from the Picking Manager. More...

Public Member Functions inherited from vtkProp
vtkProp *	NewInstance () const

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

virtual void	SetVisibility (vtkTypeBool)
	Set/Get visibility of this vtkProp. More...

virtual vtkTypeBool	GetVisibility ()

virtual void	VisibilityOn ()

virtual void	VisibilityOff ()

virtual void	SetPickable (vtkTypeBool)
	Set/Get the pickable instance variable. More...

virtual vtkTypeBool	GetPickable ()

virtual void	PickableOn ()

virtual void	PickableOff ()

virtual void	Pick ()
	Method fires PickEvent if the prop is picked. More...

virtual void	SetDragable (vtkTypeBool)
	Set/Get the value of the dragable instance variable. More...

virtual vtkTypeBool	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 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 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 vtkTypeBool	HasOpaqueGeometry ()
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS Does this prop have some opaque geometry? This method is called during the rendering process to know if there is some opaque geometry. 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 void	ProcessSelectorPixelBuffers (vtkHardwareSelector *, std::vector< unsigned int > &)
	allows a prop to update a selections color buffers 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)

virtual void	SetShaderProperty (vtkShaderProperty *property)
	Set/Get the shader property. More...

virtual vtkShaderProperty *	GetShaderProperty ()

virtual bool	IsRenderingTranslucentPolygonalGeometry ()

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

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 )

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)

vtkTypeBool	HasObserver (const char event, vtkCommand )

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

vtkTypeBool	HasObserver (unsigned long event)

vtkTypeBool	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 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	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 vtkBiDimensionalRepresentation2D *	New ()
	Instantiate the class. More...

static vtkTypeBool	IsTypeOf (const char *type)

static vtkBiDimensionalRepresentation2D *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkBiDimensionalRepresentation
static vtkTypeBool	IsTypeOf (const char *type)

static vtkBiDimensionalRepresentation *	SafeDownCast (vtkObjectBase *o)

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

static vtkWidgetRepresentation *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkProp
static vtkTypeBool	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

	vtkBiDimensionalRepresentation2D ()

	~vtkBiDimensionalRepresentation2D () override

void	ProjectOrthogonalPoint (double x[4], double y[3], double x1[3], double x2[3], double x21[3], double dir, double xP[3])

Protected Member Functions inherited from vtkBiDimensionalRepresentation
	vtkBiDimensionalRepresentation ()

	~vtkBiDimensionalRepresentation () override

Protected Member Functions inherited from vtkWidgetRepresentation
	vtkWidgetRepresentation ()

	~vtkWidgetRepresentation () override

void	AdjustBounds (double bounds[6], double newBounds[6], double center[3])

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

vtkAssemblyPath *	GetAssemblyPath3DPoint (double pos[3], vtkAbstractPropPicker *picker)

bool	NearbyEvent (int X, int Y, double bounds[6])

double	SizeHandlesRelativeToViewport (double factor, double pos[3])

double	SizeHandlesInPixels (double factor, double pos[3])

void	UpdatePropPose (vtkProp3D prop, const double pos1, const double orient1, const double pos2, const double *orient2)

Protected Member Functions inherited from vtkProp
	vtkProp ()

	~vtkProp () override

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=nullptr)
	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	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
vtkCellArray *	LineCells

vtkPoints *	LinePoints

vtkPolyData *	LinePolyData

vtkPolyDataMapper2D *	LineMapper

vtkActor2D *	LineActor

vtkProperty2D *	LineProperty

vtkProperty2D *	SelectedLineProperty

vtkTextProperty *	TextProperty

vtkTextMapper *	TextMapper

vtkActor2D *	TextActor

Protected Attributes inherited from vtkBiDimensionalRepresentation
int	Modifier

vtkHandleRepresentation *	HandleRepresentation

vtkHandleRepresentation *	Point1Representation

vtkHandleRepresentation *	Point2Representation

vtkHandleRepresentation *	Point3Representation

vtkHandleRepresentation *	Point4Representation

int	Tolerance

vtkTypeBool	Line1Visibility

vtkTypeBool	Line2Visibility

vtkIdType	ID

int	IDInitialized

double	P1World [3]

double	P2World [3]

double	P3World [3]

double	P4World [3]

double	P21World [3]

double	P43World [3]

double	T21

double	T43

double	CenterWorld [3]

double	StartEventPositionWorld [4]

char *	LabelFormat

vtkTypeBool	ShowLabelAboveWidget

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

vtkTypeBool	NeedToRender

vtkTimeStamp	BuildTime

vtkNew< vtkTransform >	TempTransform

vtkNew< vtkMatrix4x4 >	TempMatrix

Protected Attributes inherited from vtkProp
vtkTypeBool	Visibility

vtkTypeBool	Pickable

vtkTypeBool	Dragable

bool	UseBounds

double	AllocatedRenderTime

double	EstimatedRenderTime

double	SavedEstimatedRenderTime

double	RenderTimeMultiplier

int	NumberOfConsumers

vtkObject **	Consumers

vtkAssemblyPaths *	Paths

vtkInformation *	PropertyKeys

vtkShaderProperty *	ShaderProperty

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

represent the vtkBiDimensionalWidget

The vtkBiDimensionalRepresentation2D is used to represent the bi-dimensional measure in a 2D (overlay) context. This representation consists of two perpendicular lines defined by four vtkHandleRepresentations. The four handles can be independently manipulated consistent with the orthogonal constraint on the lines. (Note: the four points are referred to as Point1, Point2, Point3 and Point4. Point1 and Point2 define the first line; and Point3 and Point4 define the second orthogonal line.)

To create this widget, you click to place the first two points. The third point is mirrored with the fourth point; when you place the third point (which is orthogonal to the lined defined by the first two points), the fourth point is dropped as well. After definition, the four points can be moved (in constrained fashion, preserving orthogonality). Further, the entire widget can be translated by grabbing the center point of the widget; each line can be moved along the other line; and the entire widget can be rotated around its center point.

See also: vtkAngleWidget vtkHandleRepresentation vtkBiDimensionalRepresentation

Definition at line 57 of file vtkBiDimensionalRepresentation2D.h.

Member Typedef Documentation

◆ Superclass

typedef vtkBiDimensionalRepresentation vtkBiDimensionalRepresentation2D::Superclass

Standard VTK methods.

Definition at line 70 of file vtkBiDimensionalRepresentation2D.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enumerator
Outside
NearP1
NearP2
NearP3
NearP4
OnL1Inner
OnL1Outer
OnL2Inner
OnL2Outer
OnCenter

Definition at line 92 of file vtkBiDimensionalRepresentation2D.h.

Constructor & Destructor Documentation

◆ vtkBiDimensionalRepresentation2D()

vtkBiDimensionalRepresentation2D::vtkBiDimensionalRepresentation2D ( )

protected

◆ ~vtkBiDimensionalRepresentation2D()

vtkBiDimensionalRepresentation2D::~vtkBiDimensionalRepresentation2D ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkBiDimensionalRepresentation2D* vtkBiDimensionalRepresentation2D::New ( )

static

Instantiate the class.

◆ IsTypeOf()

static vtkTypeBool vtkBiDimensionalRepresentation2D::IsTypeOf ( const char * type )

static

◆ IsA()

virtual vtkTypeBool vtkBiDimensionalRepresentation2D::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 vtkBiDimensionalRepresentation.

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkBiDimensionalRepresentation2D::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkBiDimensionalRepresentation.

◆ NewInstance()

vtkBiDimensionalRepresentation2D* vtkBiDimensionalRepresentation2D::NewInstance ( ) const

◆ PrintSelf()

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

overridevirtual

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

◆ GetLineProperty()

virtual vtkProperty2D* vtkBiDimensionalRepresentation2D::GetLineProperty ( )

virtual

Retrieve the property used to control the appearance of the two orthogonal lines.

◆ GetSelectedLineProperty()

virtual vtkProperty2D* vtkBiDimensionalRepresentation2D::GetSelectedLineProperty ( )

virtual

◆ GetTextProperty()

virtual vtkTextProperty* vtkBiDimensionalRepresentation2D::GetTextProperty ( )

virtual

Retrieve the property used to control the appearance of the text labels.

◆ BuildRepresentation()

void vtkBiDimensionalRepresentation2D::BuildRepresentation ( )

overridevirtual

These are methods that satisfy vtkWidgetRepresentation's API.

Implements vtkWidgetRepresentation.

◆ ComputeInteractionState()

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

overridevirtual

Reimplemented from vtkWidgetRepresentation.

◆ StartWidgetDefinition()

void vtkBiDimensionalRepresentation2D::StartWidgetDefinition ( double e[2] )

overridevirtual

These are methods that satisfy vtkWidgetRepresentation's API.

Implements vtkBiDimensionalRepresentation.

◆ Point2WidgetInteraction()

void vtkBiDimensionalRepresentation2D::Point2WidgetInteraction ( double e[2] )

overridevirtual

Implements vtkBiDimensionalRepresentation.

◆ Point3WidgetInteraction()

void vtkBiDimensionalRepresentation2D::Point3WidgetInteraction ( double e[2] )

overridevirtual

Implements vtkBiDimensionalRepresentation.

◆ StartWidgetManipulation()

void vtkBiDimensionalRepresentation2D::StartWidgetManipulation ( double e[2] )

overridevirtual

Implements vtkBiDimensionalRepresentation.

◆ WidgetInteraction()

void vtkBiDimensionalRepresentation2D::WidgetInteraction ( double e[2] )

overridevirtual

Reimplemented from vtkWidgetRepresentation.

◆ Highlight()

void vtkBiDimensionalRepresentation2D::Highlight ( int highlightOn )

override

◆ ReleaseGraphicsResources()

void vtkBiDimensionalRepresentation2D::ReleaseGraphicsResources ( vtkWindow * w )

overridevirtual

Methods required by vtkProp superclass.

Reimplemented from vtkProp.

◆ RenderOverlay()

int vtkBiDimensionalRepresentation2D::RenderOverlay ( vtkViewport * viewport )

overridevirtual

Reimplemented from vtkProp.

◆ GetLabelText()

char* vtkBiDimensionalRepresentation2D::GetLabelText ( )

overridevirtual

Get the text shown in the widget's label.

Implements vtkBiDimensionalRepresentation.

◆ GetLabelPosition() [1/2]

double* vtkBiDimensionalRepresentation2D::GetLabelPosition ( )

overridevirtual

Get the position of the widget's label in display coordinates.

Implements vtkBiDimensionalRepresentation.

◆ GetLabelPosition() [2/2]

void vtkBiDimensionalRepresentation2D::GetLabelPosition ( double pos[3] )

overridevirtual

Implements vtkBiDimensionalRepresentation.

◆ GetWorldLabelPosition()

void vtkBiDimensionalRepresentation2D::GetWorldLabelPosition ( double pos[3] )

overridevirtual

Implements vtkBiDimensionalRepresentation.

◆ ProjectOrthogonalPoint()

void vtkBiDimensionalRepresentation2D::ProjectOrthogonalPoint	(	double	x[4],
		double	y[3],
		double	x1[3],
		double	x2[3],
		double	x21[3],
		double	dir,
		double	xP[3]
	)

protected

Member Data Documentation

◆ LineCells

vtkCellArray* vtkBiDimensionalRepresentation2D::LineCells

protected

Definition at line 147 of file vtkBiDimensionalRepresentation2D.h.

◆ LinePoints

vtkPoints* vtkBiDimensionalRepresentation2D::LinePoints

protected

Definition at line 148 of file vtkBiDimensionalRepresentation2D.h.

◆ LinePolyData

vtkPolyData* vtkBiDimensionalRepresentation2D::LinePolyData

protected

Definition at line 149 of file vtkBiDimensionalRepresentation2D.h.

◆ LineMapper

vtkPolyDataMapper2D* vtkBiDimensionalRepresentation2D::LineMapper

protected

Definition at line 150 of file vtkBiDimensionalRepresentation2D.h.

◆ LineActor

vtkActor2D* vtkBiDimensionalRepresentation2D::LineActor

protected

Definition at line 151 of file vtkBiDimensionalRepresentation2D.h.

◆ LineProperty

vtkProperty2D* vtkBiDimensionalRepresentation2D::LineProperty

protected

Definition at line 152 of file vtkBiDimensionalRepresentation2D.h.

◆ SelectedLineProperty

vtkProperty2D* vtkBiDimensionalRepresentation2D::SelectedLineProperty

protected

Definition at line 153 of file vtkBiDimensionalRepresentation2D.h.

◆ TextProperty

vtkTextProperty* vtkBiDimensionalRepresentation2D::TextProperty

protected

Definition at line 156 of file vtkBiDimensionalRepresentation2D.h.

◆ TextMapper

vtkTextMapper* vtkBiDimensionalRepresentation2D::TextMapper

protected

Definition at line 157 of file vtkBiDimensionalRepresentation2D.h.

◆ TextActor

vtkActor2D* vtkBiDimensionalRepresentation2D::TextActor

protected

Definition at line 158 of file vtkBiDimensionalRepresentation2D.h.

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

dox/Interaction/Widgets/vtkBiDimensionalRepresentation2D.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

◆ vtkBiDimensionalRepresentation2D()

◆ ~vtkBiDimensionalRepresentation2D()

Member Function Documentation

◆ New()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ GetLineProperty()

◆ GetSelectedLineProperty()

◆ GetTextProperty()

◆ BuildRepresentation()

◆ ComputeInteractionState()

◆ StartWidgetDefinition()

◆ Point2WidgetInteraction()

◆ Point3WidgetInteraction()

◆ StartWidgetManipulation()

◆ WidgetInteraction()

◆ Highlight()

◆ ReleaseGraphicsResources()

◆ RenderOverlay()

◆ GetLabelText()

◆ GetLabelPosition() [1/2]

◆ GetLabelPosition() [2/2]

◆ GetWorldLabelPosition()

◆ ProjectOrthogonalPoint()

Member Data Documentation

◆ LineCells

◆ LinePoints

◆ LinePolyData

◆ LineMapper

◆ LineActor

◆ LineProperty

◆ SelectedLineProperty

◆ TextProperty

◆ TextMapper

◆ TextActor