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

represent surface properties of a 2D image More...

#include <vtkProperty2D.h>

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

Public Types

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...
 
vtkProperty2DNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void DeepCopy (vtkProperty2D *p)
 Assign one property to another. More...
 
virtual void Render (vtkViewport *vtkNotUsed(viewport))
 Have the device specific subclass render this property. More...
 
virtual void SetColor (double, double, double)
 Set/Get the RGB color of this property. More...
 
virtual void SetColor (double[3])
 Set/Get the RGB color of this property. More...
 
virtual double * GetColor ()
 Set/Get the RGB color of this property. More...
 
virtual void GetColor (double &, double &, double &)
 Set/Get the RGB color of this property. More...
 
virtual void GetColor (double[3])
 Set/Get the RGB color of this property. More...
 
virtual double GetOpacity ()
 Set/Get the Opacity of this property. More...
 
virtual void SetOpacity (double)
 Set/Get the Opacity of this property. More...
 
virtual void SetPointSize (float)
 Set/Get the diameter of a Point. More...
 
virtual float GetPointSize ()
 Set/Get the diameter of a Point. More...
 
virtual void SetLineWidth (float)
 Set/Get the width of a Line. More...
 
virtual float GetLineWidth ()
 Set/Get the width of a Line. More...
 
virtual void SetLineStipplePattern (int)
 Set/Get the stippling pattern of a Line, as a 16-bit binary pattern (1 = pixel on, 0 = pixel off). More...
 
virtual int GetLineStipplePattern ()
 Set/Get the stippling pattern of a Line, as a 16-bit binary pattern (1 = pixel on, 0 = pixel off). More...
 
virtual void SetLineStippleRepeatFactor (int)
 Set/Get the stippling repeat factor of a Line, which specifies how many times each bit in the pattern is to be repeated. More...
 
virtual int GetLineStippleRepeatFactor ()
 Set/Get the stippling repeat factor of a Line, which specifies how many times each bit in the pattern is to be repeated. More...
 
virtual void SetDisplayLocation (int)
 The DisplayLocation is either background or foreground. More...
 
virtual int GetDisplayLocation ()
 The DisplayLocation is either background or foreground. More...
 
void SetDisplayLocationToBackground ()
 The DisplayLocation is either background or foreground. More...
 
void SetDisplayLocationToForeground ()
 The DisplayLocation is either background or foreground. 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...
 
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)
 
vtkTypeBool InvokeEvent (unsigned long event)
 
vtkTypeBool InvokeEvent (const char *event)
 
std::string GetObjectDescription () const override
 The object description printed in messages and PrintSelf output. 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)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
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)
 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, 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...
 
vtkTypeBool InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
vtkTypeBool InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
virtual void SetObjectName (const std::string &objectName)
 Set/get the name of this object for reporting purposes. More...
 
virtual std::string GetObjectName () const
 Set/get the name of this object for reporting purposes. More...
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
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). 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...
 
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...
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual bool UsesGarbageCollector () const
 Indicate whether the class uses vtkGarbageCollector or not. More...
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkProperty2DSafeDownCast (vtkObjectBase *o)
 
static vtkProperty2DNew ()
 Creates a vtkProperty2D with the following default values: Opacity 1, Color (1,1,1) 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 (vtkTypeBool val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static vtkTypeBool GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
- 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 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). More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...
 
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. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkProperty2D ()
 
 ~vtkProperty2D () 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 ()
 These methods allow a command to exclusively grab all events. More...
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

double Color [3]
 
double Opacity
 
float PointSize
 
float LineWidth
 
int LineStipplePattern
 
int LineStippleRepeatFactor
 
int DisplayLocation
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
std::string ObjectName
 
- 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

represent surface properties of a 2D image

vtkProperty2D contains properties used to render two dimensional images and annotations.

See also
vtkActor2D
Online Examples:

Tests:
vtkProperty2D (Tests)

Definition at line 138 of file vtkProperty2D.h.

Member Typedef Documentation

◆ Superclass

Definition at line 141 of file vtkProperty2D.h.

Constructor & Destructor Documentation

◆ vtkProperty2D()

vtkProperty2D::vtkProperty2D ( )
protected

◆ ~vtkProperty2D()

vtkProperty2D::~vtkProperty2D ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

◆ IsA()

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

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkProperty2D::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkProperty2D* vtkProperty2D::NewInstance ( ) const

◆ PrintSelf()

void vtkProperty2D::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.

◆ New()

static vtkProperty2D* vtkProperty2D::New ( )
static

Creates a vtkProperty2D with the following default values: Opacity 1, Color (1,1,1)

◆ DeepCopy()

void vtkProperty2D::DeepCopy ( vtkProperty2D p)

Assign one property to another.

◆ SetColor() [1/2]

virtual void vtkProperty2D::SetColor ( double  ,
double  ,
double   
)
virtual

Set/Get the RGB color of this property.

◆ SetColor() [2/2]

virtual void vtkProperty2D::SetColor ( double  [3])
virtual

Set/Get the RGB color of this property.

◆ GetColor() [1/3]

virtual double* vtkProperty2D::GetColor ( )
virtual

Set/Get the RGB color of this property.

◆ GetColor() [2/3]

virtual void vtkProperty2D::GetColor ( double &  ,
double &  ,
double &   
)
virtual

Set/Get the RGB color of this property.

◆ GetColor() [3/3]

virtual void vtkProperty2D::GetColor ( double  [3])
virtual

Set/Get the RGB color of this property.

◆ GetOpacity()

virtual double vtkProperty2D::GetOpacity ( )
virtual

Set/Get the Opacity of this property.

◆ SetOpacity()

virtual void vtkProperty2D::SetOpacity ( double  )
virtual

Set/Get the Opacity of this property.

◆ SetPointSize()

virtual void vtkProperty2D::SetPointSize ( float  )
virtual

Set/Get the diameter of a Point.

The size is expressed in screen units. This is only implemented for OpenGL. The default is 1.0.

◆ GetPointSize()

virtual float vtkProperty2D::GetPointSize ( )
virtual

Set/Get the diameter of a Point.

The size is expressed in screen units. This is only implemented for OpenGL. The default is 1.0.

◆ SetLineWidth()

virtual void vtkProperty2D::SetLineWidth ( float  )
virtual

Set/Get the width of a Line.

The width is expressed in screen units. This is only implemented for OpenGL. The default is 1.0.

◆ GetLineWidth()

virtual float vtkProperty2D::GetLineWidth ( )
virtual

Set/Get the width of a Line.

The width is expressed in screen units. This is only implemented for OpenGL. The default is 1.0.

◆ SetLineStipplePattern()

virtual void vtkProperty2D::SetLineStipplePattern ( int  )
virtual

Set/Get the stippling pattern of a Line, as a 16-bit binary pattern (1 = pixel on, 0 = pixel off).

This is only implemented for OpenGL, not OpenGL2. The default is 0xFFFF.

◆ GetLineStipplePattern()

virtual int vtkProperty2D::GetLineStipplePattern ( )
virtual

Set/Get the stippling pattern of a Line, as a 16-bit binary pattern (1 = pixel on, 0 = pixel off).

This is only implemented for OpenGL, not OpenGL2. The default is 0xFFFF.

◆ SetLineStippleRepeatFactor()

virtual void vtkProperty2D::SetLineStippleRepeatFactor ( int  )
virtual

Set/Get the stippling repeat factor of a Line, which specifies how many times each bit in the pattern is to be repeated.

This is only implemented for OpenGL, not OpenGL2. The default is 1.

◆ GetLineStippleRepeatFactor()

virtual int vtkProperty2D::GetLineStippleRepeatFactor ( )
virtual

Set/Get the stippling repeat factor of a Line, which specifies how many times each bit in the pattern is to be repeated.

This is only implemented for OpenGL, not OpenGL2. The default is 1.

◆ SetDisplayLocation()

virtual void vtkProperty2D::SetDisplayLocation ( int  )
virtual

The DisplayLocation is either background or foreground.

If it is background, then this 2D actor will be drawn behind all 3D props or foreground 2D actors. If it is foreground, then this 2D actor will be drawn in front of all 3D props and background 2D actors. Within 2D actors of the same DisplayLocation type, order is determined by the order in which the 2D actors were added to the viewport.

◆ GetDisplayLocation()

virtual int vtkProperty2D::GetDisplayLocation ( )
virtual

The DisplayLocation is either background or foreground.

If it is background, then this 2D actor will be drawn behind all 3D props or foreground 2D actors. If it is foreground, then this 2D actor will be drawn in front of all 3D props and background 2D actors. Within 2D actors of the same DisplayLocation type, order is determined by the order in which the 2D actors were added to the viewport.

◆ SetDisplayLocationToBackground()

void vtkProperty2D::SetDisplayLocationToBackground ( )
inline

The DisplayLocation is either background or foreground.

If it is background, then this 2D actor will be drawn behind all 3D props or foreground 2D actors. If it is foreground, then this 2D actor will be drawn in front of all 3D props and background 2D actors. Within 2D actors of the same DisplayLocation type, order is determined by the order in which the 2D actors were added to the viewport.

Definition at line 221 of file vtkProperty2D.h.

◆ SetDisplayLocationToForeground()

void vtkProperty2D::SetDisplayLocationToForeground ( )
inline

The DisplayLocation is either background or foreground.

If it is background, then this 2D actor will be drawn behind all 3D props or foreground 2D actors. If it is foreground, then this 2D actor will be drawn in front of all 3D props and background 2D actors. Within 2D actors of the same DisplayLocation type, order is determined by the order in which the 2D actors were added to the viewport.

Definition at line 222 of file vtkProperty2D.h.

◆ Render()

virtual void vtkProperty2D::Render ( vtkViewport vtkNotUsedviewport)
inlinevirtual

Have the device specific subclass render this property.

Definition at line 228 of file vtkProperty2D.h.

Member Data Documentation

◆ Color

double vtkProperty2D::Color[3]
protected

Definition at line 234 of file vtkProperty2D.h.

◆ Opacity

double vtkProperty2D::Opacity
protected

Definition at line 235 of file vtkProperty2D.h.

◆ PointSize

float vtkProperty2D::PointSize
protected

Definition at line 236 of file vtkProperty2D.h.

◆ LineWidth

float vtkProperty2D::LineWidth
protected

Definition at line 237 of file vtkProperty2D.h.

◆ LineStipplePattern

int vtkProperty2D::LineStipplePattern
protected

Definition at line 238 of file vtkProperty2D.h.

◆ LineStippleRepeatFactor

int vtkProperty2D::LineStippleRepeatFactor
protected

Definition at line 239 of file vtkProperty2D.h.

◆ DisplayLocation

int vtkProperty2D::DisplayLocation
protected

Definition at line 240 of file vtkProperty2D.h.


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