vtkKWEPaintbrushShape Class Reference

An abstract class to represent a paintbrush shape. More...

#include <vtkKWEPaintbrushShape.h>

Inheritance diagram for vtkKWEPaintbrushShape:

Collaboration diagram for vtkKWEPaintbrushShape:

List of all members.

Public Types
enum	PaintbrushResizeEnum {   PaintbrushResizeUnConstrained = 0, PaintbrushResizeIsotropic, PaintbrushResizeAnisotropic, PaintbrushResize_XY,   PaintbrushResize_YZ, PaintbrushResize_XZ }
Public Member Functions
virtual int	Resize (double factor[3], int ResizeType)=0
virtual void	DeepCopy (vtkKWEPaintbrushShape *)
virtual void	GetAnnotation (char *)=0
virtual void	GetExtent (int extent[6], double p[3])=0
	vtkTypeRevisionMacro (vtkKWEPaintbrushShape, vtkObject)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual vtkSmartPointer < vtkPolyData >	GetShapePolyData (double *center, vtkPlane *plane=NULL)=0
virtual void	GetStencil (vtkImageStencilData *, double p[3])=0
virtual void	GetGrayscaleData (vtkImageData *, double p[3])=0
void	GetPaintbrushData (vtkKWEPaintbrushData *, int x, int y, int z)
void	GetPaintbrushData (vtkKWEPaintbrushData *, double p[3])
virtual void	SetSpacing (double, double, double)
virtual void	SetSpacing (double[3])
virtual double *	GetSpacing ()
virtual void	GetSpacing (double &, double &, double &)
virtual void	GetSpacing (double[3])
virtual void	SetOrigin (double, double, double)
virtual void	SetOrigin (double[3])
virtual double *	GetOrigin ()
virtual void	GetOrigin (double &, double &, double &)
virtual void	GetOrigin (double[3])
virtual void	SetScalarType (int)
virtual int	GetScalarType ()
virtual void	SetPolarity (int)
virtual int	GetPolarity ()
virtual void	SetPolarityToDraw ()
virtual void	SetPolarityToErase ()
virtual void	SetResizeConstraint (int)
virtual int	GetResizeConstraint ()
virtual int	IsInside (double vtkNotUsed(currPos)[3], double vtkNotUsed(testPos)[3])
virtual double *	GetWidth ()=0
virtual void	GetWidth (double &, double &, double &)=0
virtual void	SetRepresentation (int)
virtual int	GetRepresentation ()
virtual void	SetMaxWidth (double, double, double)
virtual void	SetMaxWidth (double[3])
virtual double *	GetMaxWidth ()
virtual void	GetMaxWidth (double &, double &, double &)
virtual void	GetMaxWidth (double[3])
void	SetClipExtent (int e[6])
void	GetClipExtent (int e[6])
int *	GetClipExtent ()
Protected Member Functions
	vtkKWEPaintbrushShape ()
	~vtkKWEPaintbrushShape ()
Protected Attributes
double	Spacing [3]
double	Origin [3]
int	ScalarType
int	Polarity
int	ResizeConstraint
int	Representation
double	MaxWidth [3]
int	ClipExtent [6]

---

Detailed Description

An abstract class to represent a paintbrush shape.

The class represents a paintbrush shape. It defines two pure virtual methods: GetStencil and GetShapePolyData. The first returns the shape stencil centered at a given point. The second returns the shape polydata in world coordinates intersecting with the specified plane. If the plane is NULL, it should return the shape polydata in 3D.

Definition at line 46 of file vtkKWEPaintbrushShape.h.

---

Member Enumeration Documentation

enum vtkKWEPaintbrushShape::PaintbrushResizeEnum

Enumerator:

PaintbrushResizeUnConstrained
PaintbrushResizeIsotropic
PaintbrushResizeAnisotropic
PaintbrushResize_XY
PaintbrushResize_YZ
PaintbrushResize_XZ

Definition at line 103 of file vtkKWEPaintbrushShape.h.

---

Constructor & Destructor Documentation

vtkKWEPaintbrushShape::vtkKWEPaintbrushShape

(

)

[protected]

vtkKWEPaintbrushShape::~vtkKWEPaintbrushShape

(

)

[protected]

---

Member Function Documentation

vtkKWEPaintbrushShape::vtkTypeRevisionMacro	(	vtkKWEPaintbrushShape	,
		vtkObject
	)

Standard methods for instances of this class.

void vtkKWEPaintbrushShape::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)			[virtual]

Standard methods for instances of this class.

Reimplemented from vtkObject.

Reimplemented in vtkKWEPaintbrushShapeBox, and vtkKWEPaintbrushShapeEllipsoid.

virtual vtkSmartPointer< vtkPolyData > vtkKWEPaintbrushShape::GetShapePolyData	(	double *	center,
		vtkPlane *	plane = NULL
	)			[pure virtual]

It allows the paintbrush representation to query the template for a paintbrush outline centered at the specified point and intersecting with the specified plane. If the plane is NULL, a polydata representation of the template in 3D is returned. Returns NULL if the plane does not intersect with the template. BTX

Implemented in vtkKWEPaintbrushShapeBox, and vtkKWEPaintbrushShapeEllipsoid.

virtual void vtkKWEPaintbrushShape::GetStencil	(	vtkImageStencilData *	,
		double	p[3]
	)			[pure virtual]

Get the template as a stencil or as a grayscale data.

Implemented in vtkKWEPaintbrushShapeBox, and vtkKWEPaintbrushShapeEllipsoid.

virtual void vtkKWEPaintbrushShape::GetGrayscaleData	(	vtkImageData *	,
		double	p[3]
	)			[pure virtual]

Get the template as a stencil or as a grayscale data.

Implemented in vtkKWEPaintbrushShapeBox, and vtkKWEPaintbrushShapeEllipsoid.

void vtkKWEPaintbrushShape::GetPaintbrushData	(	vtkKWEPaintbrushData *	,
		int	x,
		int	y,
		int	z
	)

Get the template as a stencil or as a grayscale data.

void vtkKWEPaintbrushShape::GetPaintbrushData	(	vtkKWEPaintbrushData *	,
		double	p[3]
	)

Get the template as a stencil or as a grayscale data.

virtual void vtkKWEPaintbrushShape::SetSpacing	(	double	,
		double	,
		double
	)			[virtual]

Set/Get methods to set the metadata of the image on which the template is drawn. These must be set or bad things will happen.

virtual void vtkKWEPaintbrushShape::SetSpacing

(

double

[3]

)

[virtual]

Set/Get methods to set the metadata of the image on which the template is drawn. These must be set or bad things will happen.

virtual double* vtkKWEPaintbrushShape::GetSpacing

(

)

[virtual]

Set/Get methods to set the metadata of the image on which the template is drawn. These must be set or bad things will happen.

virtual void vtkKWEPaintbrushShape::GetSpacing	(	double &	,
		double &	,
		double &
	)			[virtual]

Set/Get methods to set the metadata of the image on which the template is drawn. These must be set or bad things will happen.

virtual void vtkKWEPaintbrushShape::GetSpacing

(

double

[3]

)

[virtual]

Set/Get methods to set the metadata of the image on which the template is drawn. These must be set or bad things will happen.

virtual void vtkKWEPaintbrushShape::SetOrigin	(	double	,
		double	,
		double
	)			[virtual]

Set/Get methods to set the metadata of the image on which the template is drawn. These must be set or bad things will happen.

virtual void vtkKWEPaintbrushShape::SetOrigin

(

double

[3]

)

[virtual]

Set/Get methods to set the metadata of the image on which the template is drawn. These must be set or bad things will happen.

virtual double* vtkKWEPaintbrushShape::GetOrigin

(

)

[virtual]

Set/Get methods to set the metadata of the image on which the template is drawn. These must be set or bad things will happen.

virtual void vtkKWEPaintbrushShape::GetOrigin	(	double &	,
		double &	,
		double &
	)			[virtual]

Set/Get methods to set the metadata of the image on which the template is drawn. These must be set or bad things will happen.

virtual void vtkKWEPaintbrushShape::GetOrigin

(

double

[3]

)

[virtual]

Set/Get methods to set the metadata of the image on which the template is drawn. These must be set or bad things will happen.

virtual void vtkKWEPaintbrushShape::SetScalarType

(

int

)

[virtual]

Set the datatype of the grayscale data returned. (ie VTK_UNSIGNED_CHAR etc)

virtual int vtkKWEPaintbrushShape::GetScalarType

(

)

[virtual]

Set the datatype of the grayscale data returned. (ie VTK_UNSIGNED_CHAR etc)

virtual void vtkKWEPaintbrushShape::SetPolarity

(

int

)

[virtual]

Set the polarity of the shape. Positive by default. Positive shapes are intended to draw. Negative shapes are intended to be used for erasing.

virtual int vtkKWEPaintbrushShape::GetPolarity

(

)

[virtual]

Set the polarity of the shape. Positive by default. Positive shapes are intended to draw. Negative shapes are intended to be used for erasing.

virtual void vtkKWEPaintbrushShape::SetPolarityToDraw

(

)

[virtual]

Set the polarity of the shape. Positive by default. Positive shapes are intended to draw. Negative shapes are intended to be used for erasing.

virtual void vtkKWEPaintbrushShape::SetPolarityToErase

(

)

[virtual]

Set the polarity of the shape. Positive by default. Positive shapes are intended to draw. Negative shapes are intended to be used for erasing.

virtual void vtkKWEPaintbrushShape::SetResizeConstraint

(

int

)

[virtual]

Optionally, you may set a constraint on the resizing of the brush. This constraint is imposed during interactive resizing of the brush. See the enum: PaintbrushResizeEnum. Default is UnConstrained.

virtual int vtkKWEPaintbrushShape::GetResizeConstraint

(

)

[virtual]

Optionally, you may set a constraint on the resizing of the brush. This constraint is imposed during interactive resizing of the brush. See the enum: PaintbrushResizeEnum. Default is UnConstrained.

virtual int vtkKWEPaintbrushShape::Resize	(	double	factor[3],
		int	ResizeType
	)			[pure virtual]

INTERNAL - Do not use. Resize the shape. This method is only intended to be called from the vtkKWEPaintbrushWidget class via user-interaction. If you wish to specify an initial size for the brush, use the method SetWidth/SetRadius etc that each concrete subclass provides. 'ResizeType' must be one fo the PaintbrushResizeEnum's specified below. Returns 1 if resize is successful. 0 otherwise.

Implemented in vtkKWEPaintbrushShapeBox, and vtkKWEPaintbrushShapeEllipsoid.

virtual void vtkKWEPaintbrushShape::DeepCopy

(

vtkKWEPaintbrushShape *

)

[virtual]

Deep copy.. Synchronizes states etc.

Reimplemented in vtkKWEPaintbrushShapeBox, and vtkKWEPaintbrushShapeEllipsoid.

virtual void vtkKWEPaintbrushShape::GetAnnotation

(

char *

)

[pure virtual]

Provide some kind of contextual annotation about the shape that indicates its size etc..

Implemented in vtkKWEPaintbrushShapeBox, and vtkKWEPaintbrushShapeEllipsoid.

virtual int vtkKWEPaintbrushShape::IsInside	(	double	vtkNotUsed(currPos)[3],
		double	vtkNotUsed(testPos)[3]
	)			[inline, virtual]

Check if point is inside the shape. Subclasses must implement this.

Definition at line 140 of file vtkKWEPaintbrushShape.h.

virtual double* vtkKWEPaintbrushShape::GetWidth

(

)

[pure virtual]

Abstract method to get the width of the shape.

Implemented in vtkKWEPaintbrushShapeBox, and vtkKWEPaintbrushShapeEllipsoid.

virtual void vtkKWEPaintbrushShape::GetWidth	(	double &	,
		double &	,
		double &
	)			[pure virtual]

Abstract method to get the width of the shape.

Implemented in vtkKWEPaintbrushShapeBox, and vtkKWEPaintbrushShapeEllipsoid.

virtual void vtkKWEPaintbrushShape::SetRepresentation

(

int

)

[virtual]

Set the shape representation. Either: vtkKWEPaintbrushEnums::Binary or vtkKWEPaintbrushEnums::Grayscale

virtual int vtkKWEPaintbrushShape::GetRepresentation

(

)

[virtual]

Set the shape representation. Either: vtkKWEPaintbrushEnums::Binary or vtkKWEPaintbrushEnums::Grayscale

virtual void vtkKWEPaintbrushShape::SetMaxWidth	(	double	,
		double	,
		double
	)			[virtual]

Set the maximum width of the shape for each axe.

virtual void vtkKWEPaintbrushShape::SetMaxWidth

(

double

[3]

)

[virtual]

Set the maximum width of the shape for each axe.

virtual double* vtkKWEPaintbrushShape::GetMaxWidth

(

)

[virtual]

Set the maximum width of the shape for each axe.

virtual void vtkKWEPaintbrushShape::GetMaxWidth	(	double &	,
		double &	,
		double &
	)			[virtual]

Set the maximum width of the shape for each axe.

virtual void vtkKWEPaintbrushShape::GetMaxWidth

(

double

[3]

)

[virtual]

Set the maximum width of the shape for each axe.

void vtkKWEPaintbrushShape::SetClipExtent

(

int

e[6]

)

The etch produced by the shape can be sent through these clip extents, so as to confine it to a certain axis aligned region. The default clip extents are infinite.

void vtkKWEPaintbrushShape::GetClipExtent

(

int

e[6]

)

The etch produced by the shape can be sent through these clip extents, so as to confine it to a certain axis aligned region. The default clip extents are infinite.

int* vtkKWEPaintbrushShape::GetClipExtent

(

)

The etch produced by the shape can be sent through these clip extents, so as to confine it to a certain axis aligned region. The default clip extents are infinite.

virtual void vtkKWEPaintbrushShape::GetExtent	(	int	extent[6],
		double	p[3]
	)			[pure virtual]

INTERNAL - Do not use. Get the extents of a shape drawn at the current location.

Implemented in vtkKWEPaintbrushShapeBox, and vtkKWEPaintbrushShapeEllipsoid.

---

Member Data Documentation

double vtkKWEPaintbrushShape::Spacing[3] [protected]

Definition at line 180 of file vtkKWEPaintbrushShape.h.

double vtkKWEPaintbrushShape::Origin[3] [protected]

Definition at line 181 of file vtkKWEPaintbrushShape.h.

int vtkKWEPaintbrushShape::ScalarType [protected]

Definition at line 182 of file vtkKWEPaintbrushShape.h.

int vtkKWEPaintbrushShape::Polarity [protected]

Definition at line 183 of file vtkKWEPaintbrushShape.h.

int vtkKWEPaintbrushShape::ResizeConstraint [protected]

Definition at line 184 of file vtkKWEPaintbrushShape.h.

int vtkKWEPaintbrushShape::Representation [protected]

Definition at line 185 of file vtkKWEPaintbrushShape.h.

double vtkKWEPaintbrushShape::MaxWidth[3] [protected]

Definition at line 186 of file vtkKWEPaintbrushShape.h.

int vtkKWEPaintbrushShape::ClipExtent[6] [protected]

Definition at line 187 of file vtkKWEPaintbrushShape.h.

---

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

• dox/Widgets/vtkKWEPaintbrushShape.h