vtkBrush Class Reference

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

#include <vtkBrush.h>

Inheritance diagram for vtkBrush:

Collaboration diagram for vtkBrush:

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.
vtkBrush *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
void	SetColorF (double color[3])
	Set the color of the brush with three component doubles (RGB), ranging from 0.0 to 1.0.
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.
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.
void	SetOpacityF (double a)
	Set the opacity with a double, ranging from 0.0 (transparent) to 1.0 (opaque).
double	GetOpacityF ()
	Get the opacity ranging from 0.0 (transparent) to 1.0(opaque).
void	SetColor (unsigned char color[3])
	Set the color of the brush with three component unsigned chars (RGB), ranging from 0 to 255.
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.
void	SetOpacity (unsigned char a)
	Set the opacity with an unsigned char, ranging from 0 (transparent) to 255 (opaque).
unsigned char	GetOpacity ()
	Get the opacity ranging from 0 (transparent) to 255(opaque).
void	GetColorF (double color[4])
	Get the color of the brush - expects a double of length 4 to copy into.
void	GetColor (unsigned char color[4])
	Get the color of the brush - expects an unsigned char of length 4.
unsigned char *	GetColor ()
	Get the color of the brush - gives a pointer to the underlying data.
vtkColor4ub	GetColorObject ()
	Get the color of the brush.
void	SetTexture (vtkImageData *image)
	Set the texture that will be used to fill polygons By default, no texture is set.
void	DeepCopy (vtkBrush *brush)
	Make a deep copy of the supplied brush.
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.
void	SetColor (const vtkColor4ub &color)
	Set the color of the brush with four component unsigned chars (RGBA), ranging from 0 to 255.
virtual vtkImageData *	GetTexture ()
	Get the texture that is used to fill polygons.
virtual void	SetTextureProperties (int)
	Set properties to the texture By default, the texture is linearly stretched.
virtual int	GetTextureProperties ()
	Get the properties associated to the texture.
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.
vtkCommand *	GetCommand (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 vtkBrush *	SafeDownCast (vtkObjectBase *o)
static vtkBrush *	New ()
Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	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 vtkObjectBase *	New ()
	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 vtkObjectBase *	NewInstanceInternal () 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.
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
unsigned char *	Color
vtkColor4ub	BrushColor
vtkImageData *	Texture
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

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()
static vtkReallocingFunction	GetCurrentReallocFunction ()
static vtkFreeingFunction	GetCurrentFreeFunction ()
static vtkFreeingFunction	GetAlternateFreeFunction ()

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.

Online Examples:

ReadLegacyUnstructuredGrid

AreaPlot

Diagram

Histogram2D

MultiplePlots

Definition at line 96 of file vtkBrush.h.

Member Typedef Documentation

Superclass

typedef vtkObject vtkBrush::Superclass

Definition at line 99 of file vtkBrush.h.

Member Enumeration Documentation

TextureProperty

enum vtkBrush::TextureProperty

Texture properties.

Enumerator
Nearest
Linear
Stretch
Repeat

Definition at line 203 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

)

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

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 178 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 239 of file vtkBrush.h.

BrushColor

vtkColor4ub vtkBrush::BrushColor

protected

Definition at line 240 of file vtkBrush.h.

Texture

vtkImageData* vtkBrush::Texture

protected

Definition at line 241 of file vtkBrush.h.

TextureProperties

int vtkBrush::TextureProperties

protected

Definition at line 242 of file vtkBrush.h.

---

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

• Rendering/Context2D/vtkBrush.h