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

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

#include <vtkPolyDataItem.h>

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

Public Types

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.
 
vtkPolyDataItemNewInstance () 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.
 
void SetPolyData (vtkPolyData *polyData)
 Set the PolyData of the item.
 
void SetMappedColors (vtkUnsignedCharArray *colors)
 Set mapped colors.
 
virtual vtkPolyDataGetPolyData ()
 Get the image of the item.
 
virtual void SetPosition (float, float)
 Set the position of the bottom corner of the image.
 
void SetPosition (float[2])
 
virtual void SetScalarMode (int)
 Set the data scalar mode.
 
- 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 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.
 
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
 
 vtkPolyDataItem ()
 
 ~vtkPolyDataItem () 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

DrawHintsHelper * HintHelper
 
float Position [2]
 
vtkPolyDataPolyData
 
vtkUnsignedCharArrayMappedColors
 
int ScalarMode
 
- 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

Filter that translate a vtkPolyData 2D mesh into vtkContextItems.

Warning
The input vtkPolyData should be a 2D mesh.

Definition at line 33 of file vtkPolyDataItem.h.

Member Typedef Documentation

◆ Superclass

Definition at line 36 of file vtkPolyDataItem.h.

Constructor & Destructor Documentation

◆ vtkPolyDataItem()

vtkPolyDataItem::vtkPolyDataItem ( )
protected

◆ ~vtkPolyDataItem()

vtkPolyDataItem::~vtkPolyDataItem ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

◆ IsA()

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

Reimplemented in vtkLabeledContourPolyDataItem.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkPolyDataItem::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkContextItem.

Reimplemented in vtkLabeledContourPolyDataItem.

◆ NewInstance()

vtkPolyDataItem * vtkPolyDataItem::NewInstance ( ) const

◆ PrintSelf()

void vtkPolyDataItem::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 vtkPolyDataItem * vtkPolyDataItem::New ( )
static

◆ Paint()

bool vtkPolyDataItem::Paint ( vtkContext2D painter)
overridevirtual

Paint event for the item.

Reimplemented from vtkAbstractContextItem.

◆ SetPolyData()

void vtkPolyDataItem::SetPolyData ( vtkPolyData polyData)

Set the PolyData of the item.

◆ SetMappedColors()

void vtkPolyDataItem::SetMappedColors ( vtkUnsignedCharArray colors)

Set mapped colors.

User-selected scalars are mapped to a color lookup table externally.

◆ GetPolyData()

virtual vtkPolyData * vtkPolyDataItem::GetPolyData ( )
virtual

Get the image of the item.

◆ SetPosition() [1/2]

virtual void vtkPolyDataItem::SetPosition ( float  ,
float   
)
virtual

Set the position of the bottom corner of the image.

◆ SetPosition() [2/2]

void vtkPolyDataItem::SetPosition ( float  [2])

◆ SetScalarMode()

virtual void vtkPolyDataItem::SetScalarMode ( int  )
virtual

Set the data scalar mode.

Member Data Documentation

◆ HintHelper

DrawHintsHelper* vtkPolyDataItem::HintHelper
protected

Definition at line 77 of file vtkPolyDataItem.h.

◆ Position

float vtkPolyDataItem::Position[2]
protected

Definition at line 79 of file vtkPolyDataItem.h.

◆ PolyData

vtkPolyData* vtkPolyDataItem::PolyData
protected

Definition at line 81 of file vtkPolyDataItem.h.

◆ MappedColors

vtkUnsignedCharArray* vtkPolyDataItem::MappedColors
protected

Definition at line 83 of file vtkPolyDataItem.h.

◆ ScalarMode

int vtkPolyDataItem::ScalarMode
protected

Definition at line 85 of file vtkPolyDataItem.h.


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