Public Types | Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Friends

vtkKWEPaintbrushProperty Class Reference

#include <vtkKWEPaintbrushProperty.h>

Inheritance diagram for vtkKWEPaintbrushProperty:
Inheritance graph
[legend]
Collaboration diagram for vtkKWEPaintbrushProperty:
Collaboration graph
[legend]

List of all members.

Public Types

enum  HighlightTypeEnum { StippledInvertedHighlight, ThickHighlight, ColorHighlight }

Public Member Functions

 vtkTypeRevisionMacro (vtkKWEPaintbrushProperty, vtkObject)
void PrintSelf (ostream &os, vtkIndent indent)
void SetColor (double rgb[3])
virtual unsigned long GetMTime ()

virtual vtkKWEPaintbrushSketchGetPaintbrushSketch ()

virtual void SetIdentifier (const char *)
virtual char * GetIdentifier ()

void SetOpacity (double o)
double GetOpacity ()

virtual void SetVisibility (int)
virtual int GetVisibility ()
virtual void VisibilityOn ()
virtual void VisibilityOff ()

void SetLineWidth (float)
virtual float GetLineWidth ()

void GetColor (double rgb[3])
void GetColor (unsigned char rgb[3])
double * GetColor ()

virtual void SetHighlightType (int)
virtual int GetHighlightType ()

virtual void SetHighlightThickness (double)
virtual double GetHighlightThickness ()

virtual void SetHighlightColor (double, double, double)
virtual void SetHighlightColor (double[3])
virtual double * GetHighlightColor ()
virtual void GetHighlightColor (double &, double &, double &)
virtual void GetHighlightColor (double[3])

virtual int GetHighlight ()

void SetMutable (int)
virtual int GetMutable ()

Protected Member Functions

 vtkKWEPaintbrushProperty ()
 ~vtkKWEPaintbrushProperty ()
virtual vtkPropertyGetProperty ()
bool HasUserSpecifiedColorOverride ()
void SetColorInternal (double rgb[3])
void SetInteractionEnabled (int i)

void SetHighlight (int)
virtual void HighlightOn ()
virtual void HighlightOff ()

Static Protected Member Functions

static vtkKWEPaintbrushPropertyNew (vtkKWEPaintbrushSketch *)
static vtkKWEPaintbrushPropertyNew ()

Protected Attributes

vtkPropertyProperty

Friends

class vtkKWEPaintbrushSketch
class vtkKWEPaintbrushBlend
class vtkKWEPaintbrushRepresentationGrayscale2D
class vtkKWEPaintbrushPropertyManager
class vtkKWEPaintbrushSelectionRepresentation
class vtkKWEPaintbrushHighlightActors

Detailed Description

Definition at line 37 of file vtkKWEPaintbrushProperty.h.


Member Enumeration Documentation

Enumerator:
StippledInvertedHighlight 
ThickHighlight 
ColorHighlight 

Definition at line 109 of file vtkKWEPaintbrushProperty.h.


Constructor & Destructor Documentation

vtkKWEPaintbrushProperty::vtkKWEPaintbrushProperty (  )  [protected]
vtkKWEPaintbrushProperty::~vtkKWEPaintbrushProperty (  )  [protected]

Member Function Documentation

vtkKWEPaintbrushProperty::vtkTypeRevisionMacro ( vtkKWEPaintbrushProperty  ,
vtkObject   
)
void vtkKWEPaintbrushProperty::PrintSelf ( ostream &  os,
vtkIndent  indent 
) [virtual]

Reimplemented from vtkObject.

virtual vtkKWEPaintbrushSketch* vtkKWEPaintbrushProperty::GetPaintbrushSketch (  )  [virtual]

A drawing is always associated with a paintbrush sketch. A vtkKWEPaintbrushSketch upon creation will automatically be assigned a default property internally. You can, using this method, query the sketch to which this property is assigned.

virtual void vtkKWEPaintbrushProperty::SetIdentifier ( const char *   )  [virtual]

Set a unique identifier string. This may be rendered as annotations etc.

virtual char* vtkKWEPaintbrushProperty::GetIdentifier (  )  [virtual]

Set a unique identifier string. This may be rendered as annotations etc.

void vtkKWEPaintbrushProperty::SetOpacity ( double  o  ) 

Set/Get the object's opacity. 1.0 is totally opaque and 0.0 is completely transparent.

double vtkKWEPaintbrushProperty::GetOpacity (  ) 

Set/Get the object's opacity. 1.0 is totally opaque and 0.0 is completely transparent.

virtual void vtkKWEPaintbrushProperty::SetVisibility ( int   )  [virtual]

Set the visibility of the sketch

virtual int vtkKWEPaintbrushProperty::GetVisibility (  )  [virtual]

Set the visibility of the sketch

virtual void vtkKWEPaintbrushProperty::VisibilityOn (  )  [virtual]

Set the visibility of the sketch

virtual void vtkKWEPaintbrushProperty::VisibilityOff (  )  [virtual]

Set the visibility of the sketch

void vtkKWEPaintbrushProperty::SetLineWidth ( float   ) 

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 vtkKWEPaintbrushProperty::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.

void vtkKWEPaintbrushProperty::GetColor ( double  rgb[3]  ) 

Get the color of the property. Colors are for now, auto assigned to give the most pleasing appearance, and as far as possible ensure that colors for each segmentation are unique. Note that the values are normalized to [0-1] when the arguments passed in are double.

void vtkKWEPaintbrushProperty::GetColor ( unsigned char  rgb[3]  ) 

Get the color of the property. Colors are for now, auto assigned to give the most pleasing appearance, and as far as possible ensure that colors for each segmentation are unique. Note that the values are normalized to [0-1] when the arguments passed in are double.

double* vtkKWEPaintbrushProperty::GetColor (  ) 

Get the color of the property. Colors are for now, auto assigned to give the most pleasing appearance, and as far as possible ensure that colors for each segmentation are unique. Note that the values are normalized to [0-1] when the arguments passed in are double.

void vtkKWEPaintbrushProperty::SetColor ( double  rgb[3]  ) 

Set the color of the property. Colors are for now, auto assigned to give the most pleasing appearance, and as far as possible ensure that colors for each segmentation are unique. The moment you start assign a color to any property in a drawing the property manager will stop autoassigning "quasi-unique" colors. Note that the values are normalized to [0-1].

virtual unsigned long vtkKWEPaintbrushProperty::GetMTime (  )  [virtual]

Return this object's modified time.

Reimplemented from vtkObject.

virtual void vtkKWEPaintbrushProperty::SetHighlightType ( int   )  [virtual]

Three highlight modes are allowed. 1. Stippled inverted highlight looks better when you have an overlay, as with vtkKWEPaintbrushRepresentation2D. 2. ThickHighlight looks better when you render the brushdata as contour as is done in vtkKWEPaintbrushRepresentationGrayscale2D 3. Color Highlighting of the edges looks nice on both. Just make sure that you don't assign the same color as the highlight assigned color to the sketches you draw or you'll have trouble making out that its highlighted. Yellow is the default color Highlight. ColorHighlight is the default HighlightType.

virtual int vtkKWEPaintbrushProperty::GetHighlightType (  )  [virtual]

Three highlight modes are allowed. 1. Stippled inverted highlight looks better when you have an overlay, as with vtkKWEPaintbrushRepresentation2D. 2. ThickHighlight looks better when you render the brushdata as contour as is done in vtkKWEPaintbrushRepresentationGrayscale2D 3. Color Highlighting of the edges looks nice on both. Just make sure that you don't assign the same color as the highlight assigned color to the sketches you draw or you'll have trouble making out that its highlighted. Yellow is the default color Highlight. ColorHighlight is the default HighlightType.

virtual void vtkKWEPaintbrushProperty::SetHighlightThickness ( double   )  [virtual]

Factor by which the highlighted lines should thicken when a sketch is highlighted. Default is 2.0 (ie. the lines will appear twice as thick if highlighted). Note that this applies only if our highlight mode is ThickHighlight.

virtual double vtkKWEPaintbrushProperty::GetHighlightThickness (  )  [virtual]

Factor by which the highlighted lines should thicken when a sketch is highlighted. Default is 2.0 (ie. the lines will appear twice as thick if highlighted). Note that this applies only if our highlight mode is ThickHighlight.

virtual void vtkKWEPaintbrushProperty::SetHighlightColor ( double  ,
double  ,
double   
) [virtual]

HighlightColor. The default HighlightColor is yellow. This makes sense only if HighlightType is ColorHighlight

virtual void vtkKWEPaintbrushProperty::SetHighlightColor ( double  [3]  )  [virtual]

HighlightColor. The default HighlightColor is yellow. This makes sense only if HighlightType is ColorHighlight

virtual double* vtkKWEPaintbrushProperty::GetHighlightColor (  )  [virtual]

HighlightColor. The default HighlightColor is yellow. This makes sense only if HighlightType is ColorHighlight

virtual void vtkKWEPaintbrushProperty::GetHighlightColor ( double &  ,
double &  ,
double &   
) [virtual]

HighlightColor. The default HighlightColor is yellow. This makes sense only if HighlightType is ColorHighlight

virtual void vtkKWEPaintbrushProperty::GetHighlightColor ( double  [3]  )  [virtual]

HighlightColor. The default HighlightColor is yellow. This makes sense only if HighlightType is ColorHighlight

virtual int vtkKWEPaintbrushProperty::GetHighlight (  )  [virtual]

Are we Highlighted ?

void vtkKWEPaintbrushProperty::SetMutable ( int   ) 

Sketches can be deemed immutable or mutable. An immutable sketch cannot be modified by *user* edits. By default all sketches are mutable.

virtual int vtkKWEPaintbrushProperty::GetMutable (  )  [virtual]

Sketches can be deemed immutable or mutable. An immutable sketch cannot be modified by *user* edits. By default all sketches are mutable.

static vtkKWEPaintbrushProperty* vtkKWEPaintbrushProperty::New ( vtkKWEPaintbrushSketch  )  [static, protected]
static vtkKWEPaintbrushProperty* vtkKWEPaintbrushProperty::New (  )  [static, protected]

Reimplemented from vtkObject.

void vtkKWEPaintbrushProperty::SetHighlight ( int   )  [protected]

Highlight ?

virtual void vtkKWEPaintbrushProperty::HighlightOn (  )  [protected, virtual]

Highlight ?

virtual void vtkKWEPaintbrushProperty::HighlightOff (  )  [protected, virtual]

Highlight ?

virtual vtkProperty* vtkKWEPaintbrushProperty::GetProperty (  )  [protected, virtual]
bool vtkKWEPaintbrushProperty::HasUserSpecifiedColorOverride (  )  [protected]

Has the user specified a color. If this is true, the property manager will stop autoassigning "quasi-unique" colors.

void vtkKWEPaintbrushProperty::SetColorInternal ( double  rgb[3]  )  [protected]
void vtkKWEPaintbrushProperty::SetInteractionEnabled ( int  i  )  [protected]

Friends And Related Function Documentation

friend class vtkKWEPaintbrushSketch [friend]

Definition at line 40 of file vtkKWEPaintbrushProperty.h.

friend class vtkKWEPaintbrushBlend [friend]

Definition at line 41 of file vtkKWEPaintbrushProperty.h.

Definition at line 42 of file vtkKWEPaintbrushProperty.h.

friend class vtkKWEPaintbrushPropertyManager [friend]

Definition at line 43 of file vtkKWEPaintbrushProperty.h.

Definition at line 44 of file vtkKWEPaintbrushProperty.h.

friend class vtkKWEPaintbrushHighlightActors [friend]

Definition at line 45 of file vtkKWEPaintbrushProperty.h.


Member Data Documentation

Definition at line 175 of file vtkKWEPaintbrushProperty.h.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines