VTK
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 Types inherited from vtkObject
typedef vtkObjectBase Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkProperty2DNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
void DeepCopy (vtkProperty2D *p)
 
virtual void SetColor (double, double, double)
 
virtual void SetColor (double[3])
 
virtual doubleGetColor ()
 
virtual void GetColor (double &, double &, double &)
 
virtual void GetColor (double[3])
 
virtual double GetOpacity ()
 
virtual void SetOpacity (double)
 
virtual void SetPointSize (float)
 
virtual float GetPointSize ()
 
virtual void SetLineWidth (float)
 
virtual float GetLineWidth ()
 
virtual void SetLineStipplePattern (int)
 
virtual int GetLineStipplePattern ()
 
virtual void SetLineStippleRepeatFactor (int)
 
virtual int GetLineStippleRepeatFactor ()
 
virtual void SetDisplayLocation (int)
 
virtual int GetDisplayLocation ()
 
void SetDisplayLocationToBackground ()
 
void SetDisplayLocationToForeground ()
 
virtual void Render (vtkViewport *vtkNotUsed(viewport))
 
- Public Member Functions inherited from vtkObject
vtkObjectNewInstance () const
 
virtual void DebugOn ()
 
virtual void DebugOff ()
 
bool GetDebug ()
 
void SetDebug (bool debugFlag)
 
virtual void Modified ()
 
virtual unsigned long GetMTime ()
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 
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 *)
 
int HasObserver (unsigned long event, vtkCommand *)
 
int HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
int HasObserver (unsigned long event)
 
int HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 
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)
 
int InvokeEvent (unsigned long event, void *callData)
 
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
 
virtual void Delete ()
 
virtual void FastDelete ()
 
void Print (ostream &os)
 
virtual void Register (vtkObjectBase *o)
 
virtual void UnRegister (vtkObjectBase *o)
 
void SetReferenceCount (int)
 
void PrintRevisions (ostream &)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkProperty2DSafeDownCast (vtkObjectBase *o)
 
static vtkProperty2DNew ()
 
- Static Public Member Functions inherited from vtkObject
static int IsTypeOf (const char *type)
 
static vtkObjectSafeDownCast (vtkObjectBase *o)
 
static vtkObjectNew ()
 
static void BreakOnError ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static int IsTypeOf (const char *name)
 
static vtkObjectBaseNew ()
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkProperty2D ()
 
 ~vtkProperty2D ()
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
virtual ~vtkObject ()
 
virtual void RegisterInternal (vtkObjectBase *, int check)
 
virtual void UnRegisterInternal (vtkObjectBase *, int check)
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
 
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 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
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

represent surface properties of a 2D image

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

See also
vtkActor2D
Tests:
vtkProperty2D (Tests)

Definition at line 39 of file vtkProperty2D.h.

Member Typedef Documentation

Definition at line 42 of file vtkProperty2D.h.

Constructor & Destructor Documentation

vtkProperty2D::vtkProperty2D ( )
protected
vtkProperty2D::~vtkProperty2D ( )
protected

Member Function Documentation

static int vtkProperty2D::IsTypeOf ( const char *  type)
static
virtual int 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 vtkObject.

static vtkProperty2D* vtkProperty2D::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkProperty2D::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkObject.

vtkProperty2D* vtkProperty2D::NewInstance ( ) const
void vtkProperty2D::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual

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.

static vtkProperty2D* vtkProperty2D::New ( )
static

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

void vtkProperty2D::DeepCopy ( vtkProperty2D p)

Assign one property to another.

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

Set/Get the RGB color of this property.

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

Set/Get the RGB color of this property.

virtual double* vtkProperty2D::GetColor ( )
virtual

Set/Get the RGB color of this property.

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

Set/Get the RGB color of this property.

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

Set/Get the RGB color of this property.

virtual double vtkProperty2D::GetOpacity ( )
virtual

Set/Get the Opacity of this property.

virtual void vtkProperty2D::SetOpacity ( double  )
virtual

Set/Get the Opacity of this property.

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.

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.

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.

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.

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. The default is 0xFFFF.

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. The default is 0xFFFF.

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. The default is 1.

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. The default is 1.

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 background, 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.

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 background, 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.

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 background, 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 104 of file vtkProperty2D.h.

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 background, 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 106 of file vtkProperty2D.h.

virtual void vtkProperty2D::Render ( vtkViewport vtkNotUsedviewport)
inlinevirtual

Have the device specific subclass render this property.

Definition at line 113 of file vtkProperty2D.h.

Member Data Documentation

double vtkProperty2D::Color[3]
protected

Definition at line 121 of file vtkProperty2D.h.

double vtkProperty2D::Opacity
protected

Definition at line 122 of file vtkProperty2D.h.

float vtkProperty2D::PointSize
protected

Definition at line 123 of file vtkProperty2D.h.

float vtkProperty2D::LineWidth
protected

Definition at line 124 of file vtkProperty2D.h.

int vtkProperty2D::LineStipplePattern
protected

Definition at line 125 of file vtkProperty2D.h.

int vtkProperty2D::LineStippleRepeatFactor
protected

Definition at line 126 of file vtkProperty2D.h.

int vtkProperty2D::DisplayLocation
protected

Definition at line 127 of file vtkProperty2D.h.


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