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

provides a brush that fills shapes drawn by vtkContext2D. More...

#include <vtkBrush.h>

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

Public Types

enum  TextureProperty { Nearest = 0x01, Linear = 0x02, Stretch = 0x04, Repeat = 0x08 }
 Texture properties. More...
 
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...
 
vtkBrushNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void SetColorF (double color[3])
 Set the color of the brush with three component doubles (RGB), ranging from 0.0 to 1.0. More...
 
void SetColorF (double r, double g, double b)
 Set the color of the brush with three component doubles (RGB), ranging from 0.0 to 1.0. More...
 
void SetColorF (double r, double g, double b, double a)
 Set the color of the brush with four component doubles (RGBA), ranging from 0.0 to 1.0. More...
 
void SetOpacityF (double a)
 Set the opacity with a double, ranging from 0.0 (transparent) to 1.0 (opaque). More...
 
double GetOpacityF ()
 Get the opacity ranging from 0.0 (transparent) to 1.0(opaque). More...
 
void SetColor (unsigned char color[3])
 Set the color of the brush with three component unsigned chars (RGB), ranging from 0 to 255. More...
 
void SetColor (unsigned char r, unsigned char g, unsigned char b)
 Set the color of the brush with three component unsigned chars (RGB), ranging from 0 to 255. More...
 
void SetColor (unsigned char r, unsigned char g, unsigned char b, unsigned char a)
 Set the color of the brush with four component unsigned chars (RGBA), ranging from 0 to 255. More...
 
void SetColor (const vtkColor4ub &color)
 
void SetOpacity (unsigned char a)
 Set the opacity with an unsigned char, ranging from 0 (transparent) to 255 (opaque). More...
 
unsigned char GetOpacity ()
 Get the opacity ranging from 0 (transparent) to 255(opaque). More...
 
void GetColorF (double color[4])
 Get the color of the brush - expects a double of length 4 to copy into. More...
 
void GetColor (unsigned char color[4])
 Get the color of the brush - expects an unsigned char of length 4. More...
 
unsigned char * GetColor ()
 Get the color of the brush - gives a pointer to the underlying data. More...
 
vtkColor4ub GetColorObject ()
 Get the color of the brush. More...
 
void SetTexture (vtkImageData *image)
 Set the texture that will be used to fill polygons By default, no texture is set. More...
 
virtual vtkImageDataGetTexture ()
 Get the texture that is used to fill polygons. More...
 
virtual void SetTextureProperties (int)
 Set properties to the texture By default, the texture is linearly stretched. More...
 
virtual int GetTextureProperties ()
 Get the properties associated to the texture. More...
 
void DeepCopy (vtkBrush *brush)
 Make a deep copy of the supplied brush. 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 vtkBrushSafeDownCast (vtkObjectBase *o)
 
static vtkBrushNew ()
 
- 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
 
 vtkBrush ()
 
 ~vtkBrush () 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

unsigned char * Color
 
vtkColor4ub BrushColor
 
vtkImageDataTexture
 
int TextureProperties
 
- 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

provides a brush that fills shapes drawn by vtkContext2D.

The vtkBrush defines the fill (or pattern) of shapes that are drawn by vtkContext2D. The color is stored as four unsigned chars (RGBA), where the opacity defaults to 255, but can be modified separately to the other components. Ideally we would use a lightweight color class to store and pass around colors.

Definition at line 37 of file vtkBrush.h.

Member Typedef Documentation

◆ Superclass

Definition at line 40 of file vtkBrush.h.

Member Enumeration Documentation

◆ TextureProperty

Texture properties.

Enumerator
Nearest 
Linear 
Stretch 
Repeat 

Definition at line 144 of file vtkBrush.h.

Constructor & Destructor Documentation

◆ vtkBrush()

vtkBrush::vtkBrush ( )
protected

◆ ~vtkBrush()

vtkBrush::~vtkBrush ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkBrush::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 vtkBrush* vtkBrush::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkBrush::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkBrush* vtkBrush::NewInstance ( ) const

◆ PrintSelf()

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

◆ SetColorF() [1/3]

void vtkBrush::SetColorF ( double  color[3])

Set the color of the brush with three component doubles (RGB), ranging from 0.0 to 1.0.

◆ SetColorF() [2/3]

void vtkBrush::SetColorF ( double  r,
double  g,
double  b 
)

Set the color of the brush with three component doubles (RGB), ranging from 0.0 to 1.0.

◆ SetColorF() [3/3]

void vtkBrush::SetColorF ( double  r,
double  g,
double  b,
double  a 
)

Set the color of the brush with four component doubles (RGBA), ranging from 0.0 to 1.0.

◆ SetOpacityF()

void vtkBrush::SetOpacityF ( double  a)

Set the opacity with a double, ranging from 0.0 (transparent) to 1.0 (opaque).

◆ GetOpacityF()

double vtkBrush::GetOpacityF ( )

Get the opacity ranging from 0.0 (transparent) to 1.0(opaque).

◆ SetColor() [1/4]

void vtkBrush::SetColor ( unsigned char  color[3])

Set the color of the brush with three component unsigned chars (RGB), ranging from 0 to 255.

◆ SetColor() [2/4]

void vtkBrush::SetColor ( unsigned char  r,
unsigned char  g,
unsigned char  b 
)

Set the color of the brush with three component unsigned chars (RGB), ranging from 0 to 255.

◆ SetColor() [3/4]

void vtkBrush::SetColor ( unsigned char  r,
unsigned char  g,
unsigned char  b,
unsigned char  a 
)

Set the color of the brush with four component unsigned chars (RGBA), ranging from 0 to 255.

◆ SetColor() [4/4]

void vtkBrush::SetColor ( const vtkColor4ub color)

◆ SetOpacity()

void vtkBrush::SetOpacity ( unsigned char  a)

Set the opacity with an unsigned char, ranging from 0 (transparent) to 255 (opaque).

◆ GetOpacity()

unsigned char vtkBrush::GetOpacity ( )

Get the opacity ranging from 0 (transparent) to 255(opaque).

◆ GetColorF()

void vtkBrush::GetColorF ( double  color[4])

Get the color of the brush - expects a double of length 4 to copy into.

◆ GetColor() [1/2]

void vtkBrush::GetColor ( unsigned char  color[4])

Get the color of the brush - expects an unsigned char of length 4.

◆ GetColor() [2/2]

unsigned char* vtkBrush::GetColor ( )
inline

Get the color of the brush - gives a pointer to the underlying data.

Definition at line 119 of file vtkBrush.h.

◆ GetColorObject()

vtkColor4ub vtkBrush::GetColorObject ( )

Get the color of the brush.

◆ SetTexture()

void vtkBrush::SetTexture ( vtkImageData image)

Set the texture that will be used to fill polygons By default, no texture is set.

The image will be registered with the brush (ref count is incremented) To disable the texture, set Texture to 0.

◆ GetTexture()

virtual vtkImageData* vtkBrush::GetTexture ( )
virtual

Get the texture that is used to fill polygons.

◆ SetTextureProperties()

virtual void vtkBrush::SetTextureProperties ( int  )
virtual

Set properties to the texture By default, the texture is linearly stretched.

The behavior is undefined when Linear and Nearest are both set The behavior is undefined when Stretch and Repeat are both set The behavior is undefined if TextureProperties is 0

◆ GetTextureProperties()

virtual int vtkBrush::GetTextureProperties ( )
virtual

Get the properties associated to the texture.

◆ DeepCopy()

void vtkBrush::DeepCopy ( vtkBrush brush)

Make a deep copy of the supplied brush.

Member Data Documentation

◆ Color

unsigned char* vtkBrush::Color
protected

Definition at line 180 of file vtkBrush.h.

◆ BrushColor

vtkColor4ub vtkBrush::BrushColor
protected

Definition at line 181 of file vtkBrush.h.

◆ Texture

vtkImageData* vtkBrush::Texture
protected

Definition at line 182 of file vtkBrush.h.

◆ TextureProperties

int vtkBrush::TextureProperties
protected

Definition at line 183 of file vtkBrush.h.


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