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

Filter that translate a vtkPolyData 2D mesh into vtkContextItems. More...

#include <vtkLabeledContourPolyDataItem.h>

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

Public Types

typedef vtkPolyDataItem Superclass
 
- Public Types inherited from vtkPolyDataItem
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. More...
 
vtkLabeledContourPolyDataItemNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
bool Paint (vtkContext2D *painter) override
 Paint event for the item. More...
 
virtual void SetTextProperty (vtkTextProperty *tprop)
 The text property used to label the lines. More...
 
virtual void SetTextProperties (vtkTextPropertyCollection *coll)
 The text properties used to label the lines. More...
 
virtual vtkTextPropertyCollectionGetTextProperties ()
 
virtual vtkDoubleArrayGetTextPropertyMapping ()
 Values in this array correspond to vtkTextProperty objects in the TextProperties collection. More...
 
virtual void SetTextPropertyMapping (vtkDoubleArray *mapping)
 
virtual void SetLabelVisibility (bool)
 If true, labels will be placed and drawn during rendering. More...
 
virtual bool GetLabelVisibility ()
 
virtual void LabelVisibilityOn ()
 
virtual void LabelVisibilityOff ()
 
virtual void SetSkipDistance (double)
 Ensure that there are at least SkipDistance pixels between labels. More...
 
virtual double GetSkipDistance ()
 
- Public Member Functions inherited from vtkPolyDataItem
vtkPolyDataItemNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
bool Paint (vtkContext2D *painter) override
 Paint event for the item. More...
 
void SetPolyData (vtkPolyData *polyData)
 Set the PolyData of the item. More...
 
void SetMappedColors (vtkUnsignedCharArray *colors)
 Set mapped colors. More...
 
virtual vtkPolyDataGetPolyData ()
 Get the image of the item. More...
 
virtual void SetPosition (float, float)
 Set the position of the bottom corner of the image. More...
 
void SetPosition (float[2])
 
virtual void SetScalarMode (int)
 Set the data scalar mode. More...
 
- Public Member Functions inherited from vtkContextItem
vtkContextItemNewInstance () const
 
virtual double GetOpacity ()
 Get the opacity of the item. More...
 
virtual void SetOpacity (double)
 Set the opacity of the item. More...
 
- Public Member Functions inherited from vtkAbstractContextItem
vtkAbstractContextItemNewInstance () const
 
virtual void Update ()
 Perform any updates to the item that may be necessary before rendering. More...
 
virtual bool PaintChildren (vtkContext2D *painter)
 Paint the children of the item, should be called whenever the children need to be rendered. More...
 
virtual void ReleaseGraphicsResources ()
 Release graphics resources hold by the item. More...
 
vtkIdType AddItem (vtkAbstractContextItem *item)
 Add child items to this item. More...
 
bool RemoveItem (vtkAbstractContextItem *item)
 Remove child item from this item. More...
 
bool RemoveItem (vtkIdType index)
 Remove child item from this item. More...
 
vtkAbstractContextItemGetItem (vtkIdType index)
 Get the item at the specified index. More...
 
vtkIdType GetItemIndex (vtkAbstractContextItem *item)
 Get the index of the specified item in itemIndex. More...
 
vtkIdType GetNumberOfItems ()
 Get the number of child items. More...
 
void ClearItems ()
 Remove all child items from this item. More...
 
vtkIdType Raise (vtkIdType index)
 Raises the child to the top of the item's stack. More...
 
virtual vtkIdType StackAbove (vtkIdType index, vtkIdType under)
 Raises the child above the under sibling. More...
 
vtkIdType Lower (vtkIdType index)
 Lowers the child to the bottom of the item's stack. More...
 
virtual vtkIdType StackUnder (vtkIdType child, vtkIdType above)
 Lowers the child under the above sibling. More...
 
virtual bool Hit (const vtkContextMouseEvent &mouse)
 Return true if the supplied x, y coordinate is inside the item. More...
 
virtual vtkAbstractContextItemGetPickedItem (const vtkContextMouseEvent &mouse)
 Return the item under the mouse. More...
 
virtual bool MouseEnterEvent (const vtkContextMouseEvent &mouse)
 Mouse enter event. More...
 
virtual bool MouseMoveEvent (const vtkContextMouseEvent &mouse)
 Mouse move event. More...
 
virtual bool MouseLeaveEvent (const vtkContextMouseEvent &mouse)
 Mouse leave event. More...
 
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. More...
 
virtual bool MouseButtonReleaseEvent (const vtkContextMouseEvent &mouse)
 Mouse button release event. More...
 
virtual bool MouseDoubleClickEvent (const vtkContextMouseEvent &mouse)
 Mouse button double click event. More...
 
virtual bool MouseWheelEvent (const vtkContextMouseEvent &mouse, int delta)
 Mouse wheel event, positive delta indicates forward movement of the wheel. More...
 
virtual bool KeyPressEvent (const vtkContextKeyEvent &key)
 Key press event. More...
 
virtual bool KeyReleaseEvent (const vtkContextKeyEvent &key)
 Key release event. More...
 
virtual void SetScene (vtkContextScene *scene)
 Set the vtkContextScene for the item, always set for an item in a scene. More...
 
vtkContextSceneGetScene ()
 Get the vtkContextScene for the item, always set for an item in a scene. More...
 
virtual void SetParent (vtkAbstractContextItem *parent)
 Set the parent item. More...
 
vtkAbstractContextItemGetParent ()
 Get the parent item. More...
 
virtual vtkVector2f MapToParent (const vtkVector2f &point)
 Maps the point to the parent coordinate system. More...
 
virtual vtkVector2f MapFromParent (const vtkVector2f &point)
 Maps the point from the parent coordinate system. More...
 
virtual vtkVector2f MapToScene (const vtkVector2f &point)
 Maps the point to the scene coordinate system. More...
 
virtual vtkVector2f MapFromScene (const vtkVector2f &point)
 Maps the point from the scene coordinate system. More...
 
virtual bool GetVisible ()
 Get the visibility of the item (should it be drawn). More...
 
virtual void SetVisible (bool)
 Set the visibility of the item (should it be drawn). More...
 
virtual bool GetInteractive ()
 Get if the item is interactive (should respond to mouse events). More...
 
virtual void SetInteractive (bool)
 Set if the item is interactive (should respond to mouse events). More...
 
- 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)
 
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 vtkTypeBool IsTypeOf (const char *type)
 
static vtkLabeledContourPolyDataItemSafeDownCast (vtkObjectBase *o)
 
static vtkLabeledContourPolyDataItemNew ()
 
- Static Public Member Functions inherited from vtkPolyDataItem
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkPolyDataItemSafeDownCast (vtkObjectBase *o)
 
static vtkPolyDataItemNew ()
 
- 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. 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
 
 vtkLabeledContourPolyDataItem ()
 
 ~vtkLabeledContourPolyDataItem () override
 
virtual void ComputeBounds ()
 
void Reset ()
 
bool CheckInputs ()
 
bool CheckRebuild ()
 
bool PrepareRender ()
 
bool PlaceLabels ()
 
bool ResolveLabels ()
 
virtual bool CreateLabels ()
 
bool RenderLabels (vtkContext2D *painter)
 
bool AllocateTextActors (vtkIdType num)
 
bool FreeTextActors ()
 
- Protected Member Functions inherited from vtkPolyDataItem
 vtkPolyDataItem ()
 
 ~vtkPolyDataItem () override
 
- Protected Member Functions inherited from vtkContextItem
 vtkContextItem ()
 
 ~vtkContextItem () override
 
- Protected Member Functions inherited from vtkAbstractContextItem
 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. 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

double SkipDistance
 
bool LabelVisibility
 
vtkIdType NumberOfTextActors
 
vtkIdType NumberOfUsedTextActors
 
vtkTextActor3D ** TextActors
 
PDILabelHelper ** LabelHelpers
 
vtkSmartPointer< vtkTextPropertyCollectionTextProperties
 
vtkSmartPointer< vtkDoubleArrayTextPropertyMapping
 
vtkTimeStamp LabelBuildTime
 
- Protected Attributes inherited from vtkPolyDataItem
DrawHintsHelper * HintHelper
 
float Position [2]
 
vtkPolyDataPolyData
 
vtkUnsignedCharArrayMappedColors
 
int ScalarMode
 
- Protected Attributes inherited from vtkContextItem
double Opacity
 
- Protected Attributes inherited from vtkAbstractContextItem
vtkContextSceneScene
 Point to the scene the item is on - can be null. More...
 
vtkAbstractContextItemParent
 Point to the parent item - can be null. More...
 
vtkContextScenePrivateChildren
 This structure provides a list of children, along with convenience functions to paint the children etc. More...
 
bool Visible
 Store the visibility of the item (default is true). More...
 
bool Interactive
 Store whether the item should respond to interactions (default is true). More...
 
- 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

Filter that translate a vtkPolyData 2D mesh into vtkContextItems.

Warning
The input vtkPolyData should be a 2D mesh.

Definition at line 41 of file vtkLabeledContourPolyDataItem.h.

Member Typedef Documentation

◆ Superclass

Definition at line 44 of file vtkLabeledContourPolyDataItem.h.

Constructor & Destructor Documentation

◆ vtkLabeledContourPolyDataItem()

vtkLabeledContourPolyDataItem::vtkLabeledContourPolyDataItem ( )
protected

◆ ~vtkLabeledContourPolyDataItem()

vtkLabeledContourPolyDataItem::~vtkLabeledContourPolyDataItem ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

◆ IsA()

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

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkLabeledContourPolyDataItem::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkPolyDataItem.

◆ NewInstance()

vtkLabeledContourPolyDataItem* vtkLabeledContourPolyDataItem::NewInstance ( ) const

◆ PrintSelf()

void vtkLabeledContourPolyDataItem::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 vtkContextItem.

◆ New()

static vtkLabeledContourPolyDataItem* vtkLabeledContourPolyDataItem::New ( )
static

◆ Paint()

bool vtkLabeledContourPolyDataItem::Paint ( vtkContext2D painter)
overridevirtual

Paint event for the item.

Reimplemented from vtkAbstractContextItem.

◆ SetTextProperty()

virtual void vtkLabeledContourPolyDataItem::SetTextProperty ( vtkTextProperty tprop)
virtual

The text property used to label the lines.

Note that both vertical and horizontal justifications will be reset to "Centered" prior to rendering.

Note
This is a convenience method that clears TextProperties and inserts the argument as the only property in the collection.
See also
SetTextProperties

◆ SetTextProperties()

virtual void vtkLabeledContourPolyDataItem::SetTextProperties ( vtkTextPropertyCollection coll)
virtual

The text properties used to label the lines.

Note that both vertical and horizontal justifications will be reset to "Centered" prior to rendering.

If the TextPropertyMapping array exists, then it is used to identify which text property to use for each label as follows: If the scalar value of a line is found in the mapping, the index of the value in mapping is used to lookup the text property in the collection. If there are more mapping values than properties, the properties are looped through until the mapping is exhausted.

Lines with scalar values missing from the mapping are assigned text properties in a round-robin fashion starting from the beginning of the collection, repeating from the start of the collection as necessary.

See also
SetTextProperty
SetTextPropertyMapping

◆ GetTextProperties()

virtual vtkTextPropertyCollection* vtkLabeledContourPolyDataItem::GetTextProperties ( )
virtual

◆ GetTextPropertyMapping()

virtual vtkDoubleArray* vtkLabeledContourPolyDataItem::GetTextPropertyMapping ( )
virtual

Values in this array correspond to vtkTextProperty objects in the TextProperties collection.

If a contour line's scalar value exists in this array, the corresponding text property is used for the label. See SetTextProperties for more information.

◆ SetTextPropertyMapping()

virtual void vtkLabeledContourPolyDataItem::SetTextPropertyMapping ( vtkDoubleArray mapping)
virtual

◆ SetLabelVisibility()

virtual void vtkLabeledContourPolyDataItem::SetLabelVisibility ( bool  )
virtual

If true, labels will be placed and drawn during rendering.

Otherwise, only the mapper returned by GetPolyDataMapper() will be rendered. The default is to draw labels.

◆ GetLabelVisibility()

virtual bool vtkLabeledContourPolyDataItem::GetLabelVisibility ( )
virtual

◆ LabelVisibilityOn()

virtual void vtkLabeledContourPolyDataItem::LabelVisibilityOn ( )
virtual

◆ LabelVisibilityOff()

virtual void vtkLabeledContourPolyDataItem::LabelVisibilityOff ( )
virtual

◆ SetSkipDistance()

virtual void vtkLabeledContourPolyDataItem::SetSkipDistance ( double  )
virtual

Ensure that there are at least SkipDistance pixels between labels.

This is only enforced on labels along the same line. The default is 0.

◆ GetSkipDistance()

virtual double vtkLabeledContourPolyDataItem::GetSkipDistance ( )
virtual

◆ ComputeBounds()

virtual void vtkLabeledContourPolyDataItem::ComputeBounds ( )
protectedvirtual

◆ Reset()

void vtkLabeledContourPolyDataItem::Reset ( )
protected

◆ CheckInputs()

bool vtkLabeledContourPolyDataItem::CheckInputs ( )
protected

◆ CheckRebuild()

bool vtkLabeledContourPolyDataItem::CheckRebuild ( )
protected

◆ PrepareRender()

bool vtkLabeledContourPolyDataItem::PrepareRender ( )
protected

◆ PlaceLabels()

bool vtkLabeledContourPolyDataItem::PlaceLabels ( )
protected

◆ ResolveLabels()

bool vtkLabeledContourPolyDataItem::ResolveLabels ( )
protected

◆ CreateLabels()

virtual bool vtkLabeledContourPolyDataItem::CreateLabels ( )
protectedvirtual

◆ RenderLabels()

bool vtkLabeledContourPolyDataItem::RenderLabels ( vtkContext2D painter)
protected

◆ AllocateTextActors()

bool vtkLabeledContourPolyDataItem::AllocateTextActors ( vtkIdType  num)
protected

◆ FreeTextActors()

bool vtkLabeledContourPolyDataItem::FreeTextActors ( )
protected

Member Data Documentation

◆ SkipDistance

double vtkLabeledContourPolyDataItem::SkipDistance
protected

Definition at line 135 of file vtkLabeledContourPolyDataItem.h.

◆ LabelVisibility

bool vtkLabeledContourPolyDataItem::LabelVisibility
protected

Definition at line 137 of file vtkLabeledContourPolyDataItem.h.

◆ NumberOfTextActors

vtkIdType vtkLabeledContourPolyDataItem::NumberOfTextActors
protected

Definition at line 138 of file vtkLabeledContourPolyDataItem.h.

◆ NumberOfUsedTextActors

vtkIdType vtkLabeledContourPolyDataItem::NumberOfUsedTextActors
protected

Definition at line 139 of file vtkLabeledContourPolyDataItem.h.

◆ TextActors

vtkTextActor3D** vtkLabeledContourPolyDataItem::TextActors
protected

Definition at line 140 of file vtkLabeledContourPolyDataItem.h.

◆ LabelHelpers

PDILabelHelper** vtkLabeledContourPolyDataItem::LabelHelpers
protected

Definition at line 142 of file vtkLabeledContourPolyDataItem.h.

◆ TextProperties

vtkSmartPointer<vtkTextPropertyCollection> vtkLabeledContourPolyDataItem::TextProperties
protected

Definition at line 144 of file vtkLabeledContourPolyDataItem.h.

◆ TextPropertyMapping

vtkSmartPointer<vtkDoubleArray> vtkLabeledContourPolyDataItem::TextPropertyMapping
protected

Definition at line 145 of file vtkLabeledContourPolyDataItem.h.

◆ LabelBuildTime

vtkTimeStamp vtkLabeledContourPolyDataItem::LabelBuildTime
protected

Definition at line 147 of file vtkLabeledContourPolyDataItem.h.


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