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

a vtkContextItem that draws a block (optional label). More...

#include <vtkBlockItem.h>

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

Public Types

enum  {
  LEFT = 0 , CENTER , RIGHT , TOP ,
  BOTTOM , CUSTOM
}
 
typedef vtkContextItem Superclass
 
- Public Types inherited from vtkContextItem
typedef vtkAbstractContextItem Superclass
 
- Public Types inherited from vtkAbstractContextItem
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.
 
vtkBlockItemNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
bool Paint (vtkContext2D *painter) override
 Paint event for the item.
 
bool Hit (const vtkContextMouseEvent &mouse) override
 Returns true if the supplied x, y coordinate is inside the item.
 
bool MouseEnterEvent (const vtkContextMouseEvent &mouse) override
 Mouse enter event.
 
bool MouseMoveEvent (const vtkContextMouseEvent &mouse) override
 Mouse move event.
 
bool MouseLeaveEvent (const vtkContextMouseEvent &mouse) override
 Mouse leave event.
 
bool MouseButtonPressEvent (const vtkContextMouseEvent &mouse) override
 Mouse button down event.
 
bool MouseButtonReleaseEvent (const vtkContextMouseEvent &mouse) override
 Mouse button release event.
 
virtual void SetLabel (const vtkStdString &label)
 Set the block label.
 
virtual vtkStdString GetLabel ()
 Get the block label.
 
void SetScalarFunctor (double(*scalarFunction)(double, double))
 
virtual void SetDimensions (float, float, float, float)
 Set the dimensions of the block, elements 0 and 1 are the x and y coordinate of the bottom corner.
 
virtual void SetDimensions (float[4])
 Set the dimensions of the block, elements 0 and 1 are the x and y coordinate of the bottom corner.
 
virtual float * GetDimensions ()
 Get the dimensions of the block, elements 0 and 1 are the x and y coordinate of the bottom corner.
 
virtual void GetDimensions (float &, float &, float &, float &)
 Get the dimensions of the block, elements 0 and 1 are the x and y coordinate of the bottom corner.
 
virtual void GetDimensions (float[4])
 Get the dimensions of the block, elements 0 and 1 are the x and y coordinate of the bottom corner.
 
virtual void SetAutoComputeDimensions (bool)
 When set to true, the dimensions for the block are computed automatically using the anchor point, alignment at the size of the label.
 
virtual bool GetAutoComputeDimensions ()
 When set to true, the dimensions for the block are computed automatically using the anchor point, alignment at the size of the label.
 
virtual void AutoComputeDimensionsOn ()
 When set to true, the dimensions for the block are computed automatically using the anchor point, alignment at the size of the label.
 
virtual void AutoComputeDimensionsOff ()
 When set to true, the dimensions for the block are computed automatically using the anchor point, alignment at the size of the label.
 
virtual void SetHorizontalAlignment (int)
 Set/Get the horizontal alignment of the legend to the point specified.
 
virtual int GetHorizontalAlignment ()
 Set/Get the horizontal alignment of the legend to the point specified.
 
virtual void SetVerticalAlignment (int)
 Set/Get the vertical alignment of the legend to the point specified.
 
virtual int GetVerticalAlignment ()
 Set/Get the vertical alignment of the legend to the point specified.
 
virtual void SetPadding (int, int)
 When AutoComputeDimensions is true, these are the padding for the label within the block.
 
void SetPadding (int[2])
 When AutoComputeDimensions is true, these are the padding for the label within the block.
 
virtual int * GetPadding ()
 When AutoComputeDimensions is true, these are the padding for the label within the block.
 
virtual void GetPadding (int &, int &)
 When AutoComputeDimensions is true, these are the padding for the label within the block.
 
virtual void GetPadding (int[2])
 When AutoComputeDimensions is true, these are the padding for the label within the block.
 
virtual void SetMargins (int, int)
 When AutoComputeDimensions is true, these are the margins from the edge of the viewport to use when placing the block based on HorizontalAlignment and VerticalAlignment preferences.
 
void SetMargins (int[2])
 When AutoComputeDimensions is true, these are the margins from the edge of the viewport to use when placing the block based on HorizontalAlignment and VerticalAlignment preferences.
 
virtual int * GetMargins ()
 When AutoComputeDimensions is true, these are the margins from the edge of the viewport to use when placing the block based on HorizontalAlignment and VerticalAlignment preferences.
 
virtual void GetMargins (int &, int &)
 When AutoComputeDimensions is true, these are the margins from the edge of the viewport to use when placing the block based on HorizontalAlignment and VerticalAlignment preferences.
 
virtual void GetMargins (int[2])
 When AutoComputeDimensions is true, these are the margins from the edge of the viewport to use when placing the block based on HorizontalAlignment and VerticalAlignment preferences.
 
virtual vtkPenGetPen ()
 Get pen used to draw the block item outline.
 
virtual vtkBrushGetBrush ()
 Get the brush used to draw the block item background.
 
virtual vtkBrushGetMouseOverBrush ()
 Get the brush used to draw the block item background when the item is "hit" i.e.
 
void SetLabelProperties (vtkTextProperty *)
 Provides access to the vtkTextProperty object that controls the way the label is rendered.
 
virtual vtkTextPropertyGetLabelProperties ()
 Provides access to the vtkTextProperty object that controls the way the label is rendered.
 
- Public Member Functions inherited from vtkContextItem
virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
vtkContextItemNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
virtual void SetTransform (vtkContextTransform *)
 Set the transform of the item.
 
virtual double GetOpacity ()
 Get the opacity of the item.
 
virtual void SetOpacity (double)
 Set the opacity of the item.
 
- Public Member Functions inherited from vtkAbstractContextItem
virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
vtkAbstractContextItemNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
virtual void Update ()
 Perform any updates to the item that may be necessary before rendering.
 
virtual bool Paint (vtkContext2D *painter)
 Paint event for the item, called whenever the item needs to be drawn.
 
virtual bool PaintChildren (vtkContext2D *painter)
 Paint the children of the item, should be called whenever the children need to be rendered.
 
virtual void ReleaseGraphicsResources ()
 Release graphics resources hold by the item.
 
vtkIdType AddItem (vtkAbstractContextItem *item)
 Add child items to this item.
 
bool RemoveItem (vtkAbstractContextItem *item)
 Remove child item from this item.
 
bool RemoveItem (vtkIdType index)
 Remove child item from this item.
 
vtkAbstractContextItemGetItem (vtkIdType index)
 Get the item at the specified index.
 
vtkIdType GetItemIndex (vtkAbstractContextItem *item)
 Get the index of the specified item in itemIndex.
 
vtkIdType GetNumberOfItems ()
 Get the number of child items.
 
void ClearItems ()
 Remove all child items from this item.
 
vtkIdType Raise (vtkIdType index)
 Raises the child to the top of the item's stack.
 
virtual vtkIdType StackAbove (vtkIdType index, vtkIdType under)
 Raises the child above the under sibling.
 
vtkIdType Lower (vtkIdType index)
 Lowers the child to the bottom of the item's stack.
 
virtual vtkIdType StackUnder (vtkIdType child, vtkIdType above)
 Lowers the child under the above sibling.
 
virtual bool Hit (const vtkContextMouseEvent &mouse)
 Return true if the supplied x, y coordinate is inside the item.
 
virtual vtkAbstractContextItemGetPickedItem (const vtkContextMouseEvent &mouse)
 Return the item under the mouse.
 
virtual bool MouseEnterEvent (const vtkContextMouseEvent &mouse)
 Mouse enter event.
 
virtual bool MouseMoveEvent (const vtkContextMouseEvent &mouse)
 Mouse move event.
 
virtual bool MouseLeaveEvent (const vtkContextMouseEvent &mouse)
 Mouse leave event.
 
virtual bool MouseButtonPressEvent (const vtkContextMouseEvent &mouse)
 Mouse button down event Return true if the item holds the event, false if the event can be propagated to other items.
 
virtual bool MouseButtonReleaseEvent (const vtkContextMouseEvent &mouse)
 Mouse button release event.
 
virtual bool MouseDoubleClickEvent (const vtkContextMouseEvent &mouse)
 Mouse button double click event.
 
virtual bool MouseWheelEvent (const vtkContextMouseEvent &mouse, int delta)
 Mouse wheel event, positive delta indicates forward movement of the wheel.
 
virtual bool KeyPressEvent (const vtkContextKeyEvent &key)
 Key press event.
 
virtual bool KeyReleaseEvent (const vtkContextKeyEvent &key)
 Key release event.
 
virtual void SetScene (vtkContextScene *scene)
 Set the vtkContextScene for the item, always set for an item in a scene.
 
vtkContextSceneGetScene ()
 Get the vtkContextScene for the item, always set for an item in a scene.
 
virtual void SetParent (vtkAbstractContextItem *parent)
 Set the parent item.
 
vtkAbstractContextItemGetParent ()
 Get the parent item.
 
virtual vtkVector2f MapToParent (const vtkVector2f &point)
 Maps the point to the parent coordinate system.
 
virtual vtkVector2f MapFromParent (const vtkVector2f &point)
 Maps the point from the parent coordinate system.
 
virtual vtkVector2f MapToScene (const vtkVector2f &point)
 Maps the point to the scene coordinate system.
 
virtual vtkVector2f MapFromScene (const vtkVector2f &point)
 Maps the point from the scene coordinate system.
 
virtual bool GetVisible ()
 Get the visibility of the item (should it be drawn).
 
virtual void SetVisible (bool)
 Set the visibility of the item (should it be drawn).
 
virtual bool GetInteractive ()
 Get if the item is interactive (should respond to mouse events).
 
virtual void SetInteractive (bool)
 Set if the item is interactive (should respond to mouse events).
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on.
 
virtual void DebugOff ()
 Turn debugging output off.
 
bool GetDebug ()
 Get the value of the debug flag.
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag.
 
virtual void Modified ()
 Update the modification time for this object.
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time.
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
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)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
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.
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
 
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.
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
int InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string.
 
virtual vtkTypeBool IsA (const char *name)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
virtual vtkIdType GetNumberOfGenerationsFromBase (const char *name)
 Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
 
virtual void Delete ()
 Delete a VTK object.
 
virtual void FastDelete ()
 Delete a reference to this object.
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream.
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object).
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object).
 
int GetReferenceCount ()
 Return the current reference count of this object.
 
void SetReferenceCount (int)
 Sets the reference count.
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space.
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses.
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses.
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkBlockItemSafeDownCast (vtkObjectBase *o)
 
static vtkBlockItemNew ()
 
- Static Public Member Functions inherited from vtkContextItem
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkContextItemSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAbstractContextItem
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkAbstractContextItemSafeDownCast (vtkObjectBase *o)
 
- 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.
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes.
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static int GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
- 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.
 
static vtkIdType GetNumberOfGenerationsFromBaseType (const char *name)
 Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
 
static bool GetUsingMemkind ()
 A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkBlockItem ()
 
 ~vtkBlockItem () override
 
- Protected Member Functions inherited from vtkContextItem
virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkContextItem ()=default
 
 ~vtkContextItem () override=default
 
- Protected Member Functions inherited from vtkAbstractContextItem
virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkAbstractContextItem ()
 
 ~vtkAbstractContextItem () 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.
 
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events.
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
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

float Dimensions [4]
 
vtkStdString Label
 
bool MouseOver
 
double(* scalarFunction )(double, double)
 
- Protected Attributes inherited from vtkContextItem
double Opacity = 1.0
 
vtkContextTransformTransform = nullptr
 
- Protected Attributes inherited from vtkAbstractContextItem
vtkContextSceneScene
 Point to the scene the item is on - can be null.
 
vtkAbstractContextItemParent
 Point to the parent item - can be null.
 
vtkContextScenePrivateChildren
 This structure provides a list of children, along with convenience functions to paint the children etc.
 
bool Visible
 Store the visibility of the item (default is true).
 
bool Interactive
 Store whether the item should respond to interactions (default is true).
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Additional Inherited Members

- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 

Detailed Description

a vtkContextItem that draws a block (optional label).

This is a vtkContextItem that can be placed into a vtkContextScene. It draws a block of the given dimensions, and reacts to mouse events.

vtkBlockItem can also be used to render label in the scene. The label properties can be set using vtkTextProperty accessed via GetLabelProperties.

Definition at line 42 of file vtkBlockItem.h.

Member Typedef Documentation

◆ Superclass

Definition at line 45 of file vtkBlockItem.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
LEFT 
CENTER 
RIGHT 
TOP 
BOTTOM 
CUSTOM 

Definition at line 128 of file vtkBlockItem.h.

Constructor & Destructor Documentation

◆ vtkBlockItem()

vtkBlockItem::vtkBlockItem ( )
protected

◆ ~vtkBlockItem()

vtkBlockItem::~vtkBlockItem ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

◆ IsA()

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

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkBlockItem::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkContextItem.

◆ NewInstance()

vtkBlockItem * vtkBlockItem::NewInstance ( ) const

◆ PrintSelf()

void vtkBlockItem::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 vtkAbstractContextItem.

◆ New()

static vtkBlockItem * vtkBlockItem::New ( )
static

◆ Paint()

bool vtkBlockItem::Paint ( vtkContext2D painter)
overridevirtual

Paint event for the item.

Reimplemented from vtkAbstractContextItem.

◆ Hit()

bool vtkBlockItem::Hit ( const vtkContextMouseEvent mouse)
overridevirtual

Returns true if the supplied x, y coordinate is inside the item.

Reimplemented from vtkAbstractContextItem.

◆ MouseEnterEvent()

bool vtkBlockItem::MouseEnterEvent ( const vtkContextMouseEvent mouse)
overridevirtual

Mouse enter event.

Reimplemented from vtkAbstractContextItem.

◆ MouseMoveEvent()

bool vtkBlockItem::MouseMoveEvent ( const vtkContextMouseEvent mouse)
overridevirtual

Mouse move event.

Reimplemented from vtkAbstractContextItem.

◆ MouseLeaveEvent()

bool vtkBlockItem::MouseLeaveEvent ( const vtkContextMouseEvent mouse)
overridevirtual

Mouse leave event.

Reimplemented from vtkAbstractContextItem.

◆ MouseButtonPressEvent()

bool vtkBlockItem::MouseButtonPressEvent ( const vtkContextMouseEvent mouse)
overridevirtual

Mouse button down event.

Reimplemented from vtkAbstractContextItem.

◆ MouseButtonReleaseEvent()

bool vtkBlockItem::MouseButtonReleaseEvent ( const vtkContextMouseEvent mouse)
overridevirtual

Mouse button release event.

Reimplemented from vtkAbstractContextItem.

◆ SetLabel()

virtual void vtkBlockItem::SetLabel ( const vtkStdString label)
virtual

Set the block label.

◆ GetLabel()

virtual vtkStdString vtkBlockItem::GetLabel ( )
virtual

Get the block label.

◆ SetDimensions() [1/2]

virtual void vtkBlockItem::SetDimensions ( float  ,
float  ,
float  ,
float   
)
virtual

Set the dimensions of the block, elements 0 and 1 are the x and y coordinate of the bottom corner.

Elements 2 and 3 are the width and height. Initial value is (0,0,0,0).

◆ SetDimensions() [2/2]

virtual void vtkBlockItem::SetDimensions ( float  [4])
virtual

Set the dimensions of the block, elements 0 and 1 are the x and y coordinate of the bottom corner.

Elements 2 and 3 are the width and height. Initial value is (0,0,0,0).

◆ GetDimensions() [1/3]

virtual float * vtkBlockItem::GetDimensions ( )
virtual

Get the dimensions of the block, elements 0 and 1 are the x and y coordinate of the bottom corner.

Elements 2 and 3 are the width and height. Initial value is (0,0,0,0)

◆ GetDimensions() [2/3]

virtual void vtkBlockItem::GetDimensions ( float &  ,
float &  ,
float &  ,
float &   
)
virtual

Get the dimensions of the block, elements 0 and 1 are the x and y coordinate of the bottom corner.

Elements 2 and 3 are the width and height. Initial value is (0,0,0,0)

◆ GetDimensions() [3/3]

virtual void vtkBlockItem::GetDimensions ( float  [4])
virtual

Get the dimensions of the block, elements 0 and 1 are the x and y coordinate of the bottom corner.

Elements 2 and 3 are the width and height. Initial value is (0,0,0,0)

◆ SetAutoComputeDimensions()

virtual void vtkBlockItem::SetAutoComputeDimensions ( bool  )
virtual

When set to true, the dimensions for the block are computed automatically using the anchor point, alignment at the size of the label.

Otherwise the Dimensions are used.

Default is false i.e Dimensions will be used.

◆ GetAutoComputeDimensions()

virtual bool vtkBlockItem::GetAutoComputeDimensions ( )
virtual

When set to true, the dimensions for the block are computed automatically using the anchor point, alignment at the size of the label.

Otherwise the Dimensions are used.

Default is false i.e Dimensions will be used.

◆ AutoComputeDimensionsOn()

virtual void vtkBlockItem::AutoComputeDimensionsOn ( )
virtual

When set to true, the dimensions for the block are computed automatically using the anchor point, alignment at the size of the label.

Otherwise the Dimensions are used.

Default is false i.e Dimensions will be used.

◆ AutoComputeDimensionsOff()

virtual void vtkBlockItem::AutoComputeDimensionsOff ( )
virtual

When set to true, the dimensions for the block are computed automatically using the anchor point, alignment at the size of the label.

Otherwise the Dimensions are used.

Default is false i.e Dimensions will be used.

◆ SetHorizontalAlignment()

virtual void vtkBlockItem::SetHorizontalAlignment ( int  )
virtual

Set/Get the horizontal alignment of the legend to the point specified.

Valid values are LEFT, CENTER and RIGHT.

◆ GetHorizontalAlignment()

virtual int vtkBlockItem::GetHorizontalAlignment ( )
virtual

Set/Get the horizontal alignment of the legend to the point specified.

Valid values are LEFT, CENTER and RIGHT.

◆ SetVerticalAlignment()

virtual void vtkBlockItem::SetVerticalAlignment ( int  )
virtual

Set/Get the vertical alignment of the legend to the point specified.

Valid values are TOP, CENTER and BOTTOM.

◆ GetVerticalAlignment()

virtual int vtkBlockItem::GetVerticalAlignment ( )
virtual

Set/Get the vertical alignment of the legend to the point specified.

Valid values are TOP, CENTER and BOTTOM.

◆ SetPadding() [1/2]

virtual void vtkBlockItem::SetPadding ( int  ,
int   
)
virtual

When AutoComputeDimensions is true, these are the padding for the label within the block.

Default is (5, 5).

◆ SetPadding() [2/2]

void vtkBlockItem::SetPadding ( int  [2])

When AutoComputeDimensions is true, these are the padding for the label within the block.

Default is (5, 5).

◆ GetPadding() [1/3]

virtual int * vtkBlockItem::GetPadding ( )
virtual

When AutoComputeDimensions is true, these are the padding for the label within the block.

Default is (5, 5).

◆ GetPadding() [2/3]

virtual void vtkBlockItem::GetPadding ( int &  ,
int &   
)
virtual

When AutoComputeDimensions is true, these are the padding for the label within the block.

Default is (5, 5).

◆ GetPadding() [3/3]

virtual void vtkBlockItem::GetPadding ( int  [2])
virtual

When AutoComputeDimensions is true, these are the padding for the label within the block.

Default is (5, 5).

◆ SetMargins() [1/2]

virtual void vtkBlockItem::SetMargins ( int  ,
int   
)
virtual

When AutoComputeDimensions is true, these are the margins from the edge of the viewport to use when placing the block based on HorizontalAlignment and VerticalAlignment preferences.

◆ SetMargins() [2/2]

void vtkBlockItem::SetMargins ( int  [2])

When AutoComputeDimensions is true, these are the margins from the edge of the viewport to use when placing the block based on HorizontalAlignment and VerticalAlignment preferences.

◆ GetMargins() [1/3]

virtual int * vtkBlockItem::GetMargins ( )
virtual

When AutoComputeDimensions is true, these are the margins from the edge of the viewport to use when placing the block based on HorizontalAlignment and VerticalAlignment preferences.

◆ GetMargins() [2/3]

virtual void vtkBlockItem::GetMargins ( int &  ,
int &   
)
virtual

When AutoComputeDimensions is true, these are the margins from the edge of the viewport to use when placing the block based on HorizontalAlignment and VerticalAlignment preferences.

◆ GetMargins() [3/3]

virtual void vtkBlockItem::GetMargins ( int  [2])
virtual

When AutoComputeDimensions is true, these are the margins from the edge of the viewport to use when placing the block based on HorizontalAlignment and VerticalAlignment preferences.

◆ GetPen()

virtual vtkPen * vtkBlockItem::GetPen ( )
virtual

Get pen used to draw the block item outline.

◆ GetBrush()

virtual vtkBrush * vtkBlockItem::GetBrush ( )
virtual

Get the brush used to draw the block item background.

◆ GetMouseOverBrush()

virtual vtkBrush * vtkBlockItem::GetMouseOverBrush ( )
virtual

Get the brush used to draw the block item background when the item is "hit" i.e.

interaction is enabled and the mouse is over the block.

◆ SetLabelProperties()

void vtkBlockItem::SetLabelProperties ( vtkTextProperty )

Provides access to the vtkTextProperty object that controls the way the label is rendered.

◆ GetLabelProperties()

virtual vtkTextProperty * vtkBlockItem::GetLabelProperties ( )
virtual

Provides access to the vtkTextProperty object that controls the way the label is rendered.

◆ SetScalarFunctor()

void vtkBlockItem::SetScalarFunctor ( double(*)(double, double)  scalarFunction)

Member Data Documentation

◆ Dimensions

float vtkBlockItem::Dimensions[4]
protected

Definition at line 214 of file vtkBlockItem.h.

◆ Label

vtkStdString vtkBlockItem::Label
protected

Definition at line 216 of file vtkBlockItem.h.

◆ MouseOver

bool vtkBlockItem::MouseOver
protected

Definition at line 218 of file vtkBlockItem.h.

◆ scalarFunction

double(* vtkBlockItem::scalarFunction) (double, double)
protected

Definition at line 221 of file vtkBlockItem.h.


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