VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkBorderRepresentation Class Reference

represent a vtkBorderWidget More...

#include <vtkBorderRepresentation.h>

Inheritance diagram for vtkBorderRepresentation:
[legend]
Collaboration diagram for vtkBorderRepresentation:
[legend]

Public Types

enum  { BORDER_OFF = 0, BORDER_ON, BORDER_ACTIVE }
 
enum  _InteractionState {
  Outside = 0, Inside, AdjustingP0, AdjustingP1,
  AdjustingP2, AdjustingP3, AdjustingE0, AdjustingE1,
  AdjustingE2, AdjustingE3
}
 Define the various states that the representation can be in. More...
 
typedef vtkWidgetRepresentation Superclass
 Define standard 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...
 
vtkBorderRepresentationNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual vtkCoordinateGetPositionCoordinate ()
 Specify opposite corners of the box defining the boundary of the widget. More...
 
virtual void SetPosition (float x[2])
 
virtual void SetPosition (float x, float y)
 
virtual float * GetPosition ()
 
virtual vtkCoordinateGetPosition2Coordinate ()
 
virtual void SetPosition2 (float x[2])
 
virtual void SetPosition2 (float x, float y)
 
virtual float * GetPosition2 ()
 
virtual void SetShowBorder (int border)
 Specify when and if the border should appear. More...
 
virtual int GetShowBorderMinValue ()
 
virtual int GetShowBorderMaxValue ()
 
virtual int GetShowBorder ()
 
void SetShowBorderToOff ()
 
void SetShowBorderToOn ()
 
void SetShowBorderToActive ()
 
virtual void SetShowVerticalBorder (int)
 Specify when and if the vertical border should appear. More...
 
virtual int GetShowVerticalBorder ()
 
virtual void SetShowHorizontalBorder (int)
 Specify when and if the horizontal border should appear. More...
 
virtual int GetShowHorizontalBorder ()
 
virtual vtkProperty2DGetBorderProperty ()
 Specify the properties of the border. More...
 
virtual void SetProportionalResize (vtkTypeBool)
 Indicate whether resizing operations should keep the x-y directions proportional to one another. More...
 
virtual vtkTypeBool GetProportionalResize ()
 
virtual void ProportionalResizeOn ()
 
virtual void ProportionalResizeOff ()
 
virtual void SetMinimumSize (int, int)
 Specify a minimum and/or maximum size (in pixels) that this representation can take. More...
 
void SetMinimumSize (int[2])
 
virtual int * GetMinimumSize ()
 
virtual void GetMinimumSize (int &, int &)
 
virtual void GetMinimumSize (int[2])
 
virtual void SetMaximumSize (int, int)
 
void SetMaximumSize (int[2])
 
virtual int * GetMaximumSize ()
 
virtual void GetMaximumSize (int &, int &)
 
virtual void GetMaximumSize (int[2])
 
virtual void SetTolerance (int)
 The tolerance representing the distance to the widget (in pixels) in which the cursor is considered to be on the widget, or on a widget feature (e.g., a corner point or edge). More...
 
virtual int GetTolerance ()
 
virtual double * GetSelectionPoint ()
 After a selection event within the region interior to the border; the normalized selection coordinates may be obtained. More...
 
virtual void GetSelectionPoint (double data[2])
 
virtual void SetMoving (vtkTypeBool)
 This is a modifier of the interaction state. More...
 
virtual vtkTypeBool GetMoving ()
 
virtual void MovingOn ()
 
virtual void MovingOff ()
 
vtkMTimeType GetMTime () override
 Return the MTime of this object. More...
 
void BuildRepresentation () override
 Subclasses should implement these methods. More...
 
void StartWidgetInteraction (double eventPos[2]) override
 
void WidgetInteraction (double eventPos[2]) override
 
virtual void GetSize (double size[2])
 
int ComputeInteractionState (int X, int Y, int modify=0) override
 
void GetActors2D (vtkPropCollection *) override
 These methods are necessary to make this representation behave as a vtkProp. More...
 
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 *) override
 
int RenderOpaqueGeometry (vtkViewport *) override
 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...
 
int RenderTranslucentPolygonalGeometry (vtkViewport *) 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...
 
- Public Member Functions inherited from vtkWidgetRepresentation
vtkWidgetRepresentationNewInstance () 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 vtkRendererGetRenderer ()
 
virtual void PlaceWidget (double *vtkNotUsed(bounds[6]))
 The following is a suggested API for widget representations. More...
 
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
vtkPropNewInstance () 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 vtkAssemblyPathGetNextPath ()
 
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 vtkMatrix4x4GetMatrix ()
 
virtual vtkInformationGetPropertyKeys ()
 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 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)
 
vtkObjectGetConsumer (int i)
 
int IsConsumer (vtkObject *c)
 
virtual void SetShaderProperty (vtkShaderProperty *property)
 Set/Get the shader property. More...
 
virtual vtkShaderPropertyGetShaderProperty ()
 
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...
 
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)
 
vtkCommandGetCommand (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 vtkBorderRepresentationNew ()
 Instantiate this class. More...
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkBorderRepresentationSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkWidgetRepresentation
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkWidgetRepresentationSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkProp
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkPropSafeDownCast (vtkObjectBase *o)
 
static vtkInformationIntegerKeyGeneralTextureUnit ()
 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 vtkInformationDoubleVectorKeyGeneralTextureTransform ()
 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 vtkObjectNew ()
 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 vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkBorderRepresentation ()
 
 ~vtkBorderRepresentation () override
 
virtual void NegotiateLayout ()
 
virtual void UpdateShowBorder ()
 
- Protected Member Functions inherited from vtkWidgetRepresentation
 vtkWidgetRepresentation ()
 
 ~vtkWidgetRepresentation () override
 
void AdjustBounds (double bounds[6], double newBounds[6], double center[3])
 
vtkPickingManagerGetPickingManager ()
 Return the picking manager associated on the context on which the widget representation currently belong. More...
 
vtkAssemblyPathGetAssemblyPath (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...
 
vtkAssemblyPathGetAssemblyPath3DPoint (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

int ShowVerticalBorder
 
int ShowHorizontalBorder
 
vtkProperty2DBorderProperty
 
vtkTypeBool ProportionalResize
 
int Tolerance
 
vtkTypeBool Moving
 
double SelectionPoint [2]
 
vtkCoordinatePositionCoordinate
 
vtkCoordinatePosition2Coordinate
 
int Negotiated
 
double StartPosition [2]
 
vtkPointsBWPoints
 
vtkPolyDataBWPolyData
 
vtkTransformBWTransform
 
vtkTransformPolyDataFilterBWTransformFilter
 
vtkPolyDataMapper2DBWMapper
 
vtkActor2DBWActor
 
int MinimumSize [2]
 
int MaximumSize [2]
 
- Protected Attributes inherited from vtkWidgetRepresentation
vtkWeakPointer< vtkRendererRenderer
 
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< vtkTransformTempTransform
 
vtkNew< vtkMatrix4x4TempMatrix
 
- 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
 
vtkAssemblyPathsPaths
 
vtkInformationPropertyKeys
 
vtkShaderPropertyShaderProperty
 
- 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 a vtkBorderWidget

This class is used to represent and render a vtBorderWidget. To use this class, you need to specify the two corners of a rectangular region.

The class is typically subclassed so that specialized representations can be created. The class defines an API and a default implementation that the vtkBorderRepresentation interacts with to render itself in the scene.

Warning
The separation of the widget event handling (e.g., vtkBorderWidget) from the representation (vtkBorderRepresentation) enables users and developers to create new appearances for the widget. It also facilitates parallel processing, where the client application handles events, and remote representations of the widget are slaves to the client (and do not handle events).
See also
vtkBorderWidget vtkTextWidget

Definition at line 54 of file vtkBorderRepresentation.h.

Member Typedef Documentation

◆ Superclass

Define standard methods.

Definition at line 66 of file vtkBorderRepresentation.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
BORDER_OFF 
BORDER_ON 
BORDER_ACTIVE 

Definition at line 84 of file vtkBorderRepresentation.h.

◆ _InteractionState

Define the various states that the representation can be in.

Enumerator
Outside 
Inside 
AdjustingP0 
AdjustingP1 
AdjustingP2 
AdjustingP3 
AdjustingE0 
AdjustingE1 
AdjustingE2 
AdjustingE3 

Definition at line 194 of file vtkBorderRepresentation.h.

Constructor & Destructor Documentation

◆ vtkBorderRepresentation()

vtkBorderRepresentation::vtkBorderRepresentation ( )
protected

◆ ~vtkBorderRepresentation()

vtkBorderRepresentation::~vtkBorderRepresentation ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkBorderRepresentation* vtkBorderRepresentation::New ( )
static

Instantiate this class.

◆ IsTypeOf()

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

◆ IsA()

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

Reimplemented in vtkCameraRepresentation, vtkCaptionRepresentation, vtkLogoRepresentation, vtkPlaybackRepresentation, vtkScalarBarRepresentation, vtkTextRepresentation, vtkProgressBarRepresentation, and vtkXYPlotRepresentation.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkBorderRepresentation::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkBorderRepresentation* vtkBorderRepresentation::NewInstance ( ) const

◆ PrintSelf()

void vtkBorderRepresentation::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 vtkObject.

Reimplemented in vtkCameraRepresentation, vtkCaptionRepresentation, vtkLogoRepresentation, vtkPlaybackRepresentation, vtkScalarBarRepresentation, vtkTextRepresentation, vtkProgressBarRepresentation, and vtkXYPlotRepresentation.

◆ GetPositionCoordinate()

virtual vtkCoordinate* vtkBorderRepresentation::GetPositionCoordinate ( )
virtual

Specify opposite corners of the box defining the boundary of the widget.

By default, these coordinates are in the normalized viewport coordinate system, with Position the lower left of the outline, and Position2 relative to Position. Note that using these methods are affected by the ProportionalResize flag. That is, if the aspect ratio of the representation is to be preserved (e.g., ProportionalResize is on), then the rectangle (Position,Position2) is a bounding rectangle.

◆ SetPosition() [1/2]

virtual void vtkBorderRepresentation::SetPosition ( float  x[2])
virtual

◆ SetPosition() [2/2]

virtual void vtkBorderRepresentation::SetPosition ( float  x,
float  y 
)
virtual

◆ GetPosition()

virtual float* vtkBorderRepresentation::GetPosition ( )
virtual

◆ GetPosition2Coordinate()

virtual vtkCoordinate* vtkBorderRepresentation::GetPosition2Coordinate ( )
virtual

◆ SetPosition2() [1/2]

virtual void vtkBorderRepresentation::SetPosition2 ( float  x[2])
virtual

◆ SetPosition2() [2/2]

virtual void vtkBorderRepresentation::SetPosition2 ( float  x,
float  y 
)
virtual

◆ GetPosition2()

virtual float* vtkBorderRepresentation::GetPosition2 ( )
virtual

◆ SetShowBorder()

virtual void vtkBorderRepresentation::SetShowBorder ( int  border)
virtual

Specify when and if the border should appear.

If ShowBorder is "on", then the border will always appear. If ShowBorder is "off" then the border will never appear. If ShowBorder is "active" then the border will appear when the mouse pointer enters the region bounded by the border widget. This method is provided as conveniency to set both horizontal and vertical borders. BORDER_ON by default. See Also: SetShowHorizontalBorder(), SetShowVerticalBorder()

◆ GetShowBorderMinValue()

virtual int vtkBorderRepresentation::GetShowBorderMinValue ( )
virtual

◆ GetShowBorderMaxValue()

virtual int vtkBorderRepresentation::GetShowBorderMaxValue ( )
virtual

◆ GetShowBorder()

virtual int vtkBorderRepresentation::GetShowBorder ( )
virtual

◆ SetShowBorderToOff()

void vtkBorderRepresentation::SetShowBorderToOff ( )
inline

Definition at line 107 of file vtkBorderRepresentation.h.

◆ SetShowBorderToOn()

void vtkBorderRepresentation::SetShowBorderToOn ( )
inline

Definition at line 108 of file vtkBorderRepresentation.h.

◆ SetShowBorderToActive()

void vtkBorderRepresentation::SetShowBorderToActive ( )
inline

Definition at line 109 of file vtkBorderRepresentation.h.

◆ SetShowVerticalBorder()

virtual void vtkBorderRepresentation::SetShowVerticalBorder ( int  )
virtual

Specify when and if the vertical border should appear.

See Also: SetShowBorder(), SetShowHorizontalBorder()

◆ GetShowVerticalBorder()

virtual int vtkBorderRepresentation::GetShowVerticalBorder ( )
virtual

◆ SetShowHorizontalBorder()

virtual void vtkBorderRepresentation::SetShowHorizontalBorder ( int  )
virtual

Specify when and if the horizontal border should appear.

See Also: SetShowBorder(), SetShowVerticalBorder()

◆ GetShowHorizontalBorder()

virtual int vtkBorderRepresentation::GetShowHorizontalBorder ( )
virtual

◆ GetBorderProperty()

virtual vtkProperty2D* vtkBorderRepresentation::GetBorderProperty ( )
virtual

Specify the properties of the border.

◆ SetProportionalResize()

virtual void vtkBorderRepresentation::SetProportionalResize ( vtkTypeBool  )
virtual

Indicate whether resizing operations should keep the x-y directions proportional to one another.

Also, if ProportionalResize is on, then the rectangle (Position,Position2) is a bounding rectangle, and the representation will be placed in the rectangle in such a way as to preserve the aspect ratio of the representation.

◆ GetProportionalResize()

virtual vtkTypeBool vtkBorderRepresentation::GetProportionalResize ( )
virtual

◆ ProportionalResizeOn()

virtual void vtkBorderRepresentation::ProportionalResizeOn ( )
virtual

◆ ProportionalResizeOff()

virtual void vtkBorderRepresentation::ProportionalResizeOff ( )
virtual

◆ SetMinimumSize() [1/2]

virtual void vtkBorderRepresentation::SetMinimumSize ( int  ,
int   
)
virtual

Specify a minimum and/or maximum size (in pixels) that this representation can take.

These methods require two values: size values in the x and y directions, respectively.

◆ SetMinimumSize() [2/2]

void vtkBorderRepresentation::SetMinimumSize ( int  [2])

◆ GetMinimumSize() [1/3]

virtual int* vtkBorderRepresentation::GetMinimumSize ( )
virtual

◆ GetMinimumSize() [2/3]

virtual void vtkBorderRepresentation::GetMinimumSize ( int &  ,
int &   
)
virtual

◆ GetMinimumSize() [3/3]

virtual void vtkBorderRepresentation::GetMinimumSize ( int  [2])
virtual

◆ SetMaximumSize() [1/2]

virtual void vtkBorderRepresentation::SetMaximumSize ( int  ,
int   
)
virtual

◆ SetMaximumSize() [2/2]

void vtkBorderRepresentation::SetMaximumSize ( int  [2])

◆ GetMaximumSize() [1/3]

virtual int* vtkBorderRepresentation::GetMaximumSize ( )
virtual

◆ GetMaximumSize() [2/3]

virtual void vtkBorderRepresentation::GetMaximumSize ( int &  ,
int &   
)
virtual

◆ GetMaximumSize() [3/3]

virtual void vtkBorderRepresentation::GetMaximumSize ( int  [2])
virtual

◆ SetTolerance()

virtual void vtkBorderRepresentation::SetTolerance ( int  )
virtual

The tolerance representing the distance to the widget (in pixels) in which the cursor is considered to be on the widget, or on a widget feature (e.g., a corner point or edge).

◆ GetTolerance()

virtual int vtkBorderRepresentation::GetTolerance ( )
virtual

◆ GetSelectionPoint() [1/2]

virtual double* vtkBorderRepresentation::GetSelectionPoint ( )
virtual

After a selection event within the region interior to the border; the normalized selection coordinates may be obtained.

◆ GetSelectionPoint() [2/2]

virtual void vtkBorderRepresentation::GetSelectionPoint ( double  data[2])
virtual

◆ SetMoving()

virtual void vtkBorderRepresentation::SetMoving ( vtkTypeBool  )
virtual

This is a modifier of the interaction state.

When set, widget interaction allows the border (and stuff inside of it) to be translated with mouse motion.

◆ GetMoving()

virtual vtkTypeBool vtkBorderRepresentation::GetMoving ( )
virtual

◆ MovingOn()

virtual void vtkBorderRepresentation::MovingOn ( )
virtual

◆ MovingOff()

virtual void vtkBorderRepresentation::MovingOff ( )
virtual

◆ GetMTime()

vtkMTimeType vtkBorderRepresentation::GetMTime ( )
overridevirtual

Return the MTime of this object.

It takes into account MTimes of position coordinates and border's property.

Reimplemented from vtkObject.

◆ BuildRepresentation()

void vtkBorderRepresentation::BuildRepresentation ( )
overridevirtual

Subclasses should implement these methods.

See the superclasses' documentation for more information.

Implements vtkWidgetRepresentation.

Reimplemented in vtkCameraRepresentation, vtkProgressBarRepresentation, vtkCaptionRepresentation, vtkLogoRepresentation, vtkPlaybackRepresentation, vtkTextRepresentation, vtkScalarBarRepresentation, and vtkXYPlotRepresentation.

◆ StartWidgetInteraction()

void vtkBorderRepresentation::StartWidgetInteraction ( double  eventPos[2])
overridevirtual

Reimplemented from vtkWidgetRepresentation.

◆ WidgetInteraction()

void vtkBorderRepresentation::WidgetInteraction ( double  eventPos[2])
overridevirtual

◆ GetSize()

virtual void vtkBorderRepresentation::GetSize ( double  size[2])
inlinevirtual

◆ ComputeInteractionState()

int vtkBorderRepresentation::ComputeInteractionState ( int  X,
int  Y,
int  modify = 0 
)
overridevirtual

Reimplemented from vtkWidgetRepresentation.

◆ GetActors2D()

void vtkBorderRepresentation::GetActors2D ( vtkPropCollection )
overridevirtual

◆ ReleaseGraphicsResources()

void vtkBorderRepresentation::ReleaseGraphicsResources ( vtkWindow )
overridevirtual

WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Release any graphics resources that are being consumed by this actor.

The parameter window could be used to determine which graphic resources to release.

Reimplemented from vtkProp.

Reimplemented in vtkScalarBarRepresentation, vtkXYPlotRepresentation, vtkCameraRepresentation, vtkProgressBarRepresentation, vtkCaptionRepresentation, vtkPlaybackRepresentation, vtkLogoRepresentation, and vtkTextRepresentation.

◆ RenderOverlay()

int vtkBorderRepresentation::RenderOverlay ( vtkViewport )
overridevirtual

◆ RenderOpaqueGeometry()

int vtkBorderRepresentation::RenderOpaqueGeometry ( vtkViewport )
overridevirtual

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.

Reimplemented in vtkCameraRepresentation, vtkProgressBarRepresentation, vtkCaptionRepresentation, vtkPlaybackRepresentation, vtkScalarBarRepresentation, vtkTextRepresentation, and vtkXYPlotRepresentation.

◆ RenderTranslucentPolygonalGeometry()

int vtkBorderRepresentation::RenderTranslucentPolygonalGeometry ( vtkViewport )
overridevirtual

◆ HasTranslucentPolygonalGeometry()

vtkTypeBool vtkBorderRepresentation::HasTranslucentPolygonalGeometry ( )
overridevirtual

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

Reimplemented in vtkCameraRepresentation, vtkProgressBarRepresentation, vtkCaptionRepresentation, vtkPlaybackRepresentation, vtkScalarBarRepresentation, vtkTextRepresentation, and vtkXYPlotRepresentation.

◆ NegotiateLayout()

virtual void vtkBorderRepresentation::NegotiateLayout ( )
protectedvirtual

◆ UpdateShowBorder()

virtual void vtkBorderRepresentation::UpdateShowBorder ( )
protectedvirtual

Member Data Documentation

◆ ShowVerticalBorder

int vtkBorderRepresentation::ShowVerticalBorder
protected

Definition at line 248 of file vtkBorderRepresentation.h.

◆ ShowHorizontalBorder

int vtkBorderRepresentation::ShowHorizontalBorder
protected

Definition at line 249 of file vtkBorderRepresentation.h.

◆ BorderProperty

vtkProperty2D* vtkBorderRepresentation::BorderProperty
protected

Definition at line 250 of file vtkBorderRepresentation.h.

◆ ProportionalResize

vtkTypeBool vtkBorderRepresentation::ProportionalResize
protected

Definition at line 251 of file vtkBorderRepresentation.h.

◆ Tolerance

int vtkBorderRepresentation::Tolerance
protected

Definition at line 252 of file vtkBorderRepresentation.h.

◆ Moving

vtkTypeBool vtkBorderRepresentation::Moving
protected

Definition at line 253 of file vtkBorderRepresentation.h.

◆ SelectionPoint

double vtkBorderRepresentation::SelectionPoint[2]
protected

Definition at line 254 of file vtkBorderRepresentation.h.

◆ PositionCoordinate

vtkCoordinate* vtkBorderRepresentation::PositionCoordinate
protected

Definition at line 257 of file vtkBorderRepresentation.h.

◆ Position2Coordinate

vtkCoordinate* vtkBorderRepresentation::Position2Coordinate
protected

Definition at line 258 of file vtkBorderRepresentation.h.

◆ Negotiated

int vtkBorderRepresentation::Negotiated
protected

Definition at line 262 of file vtkBorderRepresentation.h.

◆ StartPosition

double vtkBorderRepresentation::StartPosition[2]
protected

Definition at line 271 of file vtkBorderRepresentation.h.

◆ BWPoints

vtkPoints* vtkBorderRepresentation::BWPoints
protected

Definition at line 275 of file vtkBorderRepresentation.h.

◆ BWPolyData

vtkPolyData* vtkBorderRepresentation::BWPolyData
protected

Definition at line 276 of file vtkBorderRepresentation.h.

◆ BWTransform

vtkTransform* vtkBorderRepresentation::BWTransform
protected

Definition at line 277 of file vtkBorderRepresentation.h.

◆ BWTransformFilter

vtkTransformPolyDataFilter* vtkBorderRepresentation::BWTransformFilter
protected

Definition at line 278 of file vtkBorderRepresentation.h.

◆ BWMapper

vtkPolyDataMapper2D* vtkBorderRepresentation::BWMapper
protected

Definition at line 279 of file vtkBorderRepresentation.h.

◆ BWActor

vtkActor2D* vtkBorderRepresentation::BWActor
protected

Definition at line 280 of file vtkBorderRepresentation.h.

◆ MinimumSize

int vtkBorderRepresentation::MinimumSize[2]
protected

Definition at line 283 of file vtkBorderRepresentation.h.

◆ MaximumSize

int vtkBorderRepresentation::MaximumSize[2]
protected

Definition at line 284 of file vtkBorderRepresentation.h.


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