Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members   Related Pages  

vtkGlyphSource2D Class Reference

create 2D glyphs represented by vtkPolyData. More...

#include <vtkGlyphSource2D.h>

Inheritance diagram for vtkGlyphSource2D:

Inheritance graph
[legend]
Collaboration diagram for vtkGlyphSource2D:

Collaboration graph
[legend]
List of all members.

Public Methods

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
virtual void SetCenter (float, float, float)
virtual void SetCenter (float[3])
virtual float * GetCenter ()
virtual void GetCenter (float data[3])
virtual void SetScale (float)
virtual float GetScale ()
virtual void SetScale2 (float)
virtual float GetScale2 ()
virtual void SetColor (float, float, float)
virtual void SetColor (float[3])
virtual float * GetColor ()
virtual void GetColor (float data[3])
virtual void SetFilled (int)
virtual int GetFilled ()
virtual void FilledOn ()
virtual void FilledOff ()
virtual void SetDash (int)
virtual int GetDash ()
virtual void DashOn ()
virtual void DashOff ()
virtual void SetCross (int)
virtual int GetCross ()
virtual void CrossOn ()
virtual void CrossOff ()
virtual void SetRotationAngle (float)
virtual float GetRotationAngle ()
virtual void RotationAngleOn ()
virtual void RotationAngleOff ()
virtual void SetGlyphType (int)
virtual int GetGlyphType ()
void SetGlyphTypeToNone ()
void SetGlyphTypeToVertex ()
void SetGlyphTypeToDash ()
void SetGlyphTypeToCross ()
void SetGlyphTypeToThickCross ()
void SetGlyphTypeToTriangle ()
void SetGlyphTypeToSquare ()
void SetGlyphTypeToCircle ()
void SetGlyphTypeToDiamond ()
void SetGlyphTypeToArrow ()
void SetGlyphTypeToThickArrow ()
void SetGlyphTypeToHookedArrow ()

Static Public Methods

int IsTypeOf (const char *type)
vtkGlyphSource2D * SafeDownCast (vtkObject *o)
vtkGlyphSource2D * New ()

Protected Methods

 vtkGlyphSource2D ()
 ~vtkGlyphSource2D ()
 vtkGlyphSource2D (const vtkGlyphSource2D &)
void operator= (const vtkGlyphSource2D &)
void Execute ()
void TransformGlyph (vtkPoints *pts)
void ConvertColor ()
void CreateVertex (vtkPoints *pts, vtkCellArray *verts, vtkUnsignedCharArray *colors)
void CreateDash (vtkPoints *pts, vtkCellArray *lines, vtkCellArray *polys, vtkUnsignedCharArray *colors, float scale)
void CreateCross (vtkPoints *pts, vtkCellArray *lines, vtkCellArray *polys, vtkUnsignedCharArray *colors, float scale)
void CreateThickCross (vtkPoints *pts, vtkCellArray *lines, vtkCellArray *polys, vtkUnsignedCharArray *colors)
void CreateTriangle (vtkPoints *pts, vtkCellArray *lines, vtkCellArray *polys, vtkUnsignedCharArray *colors)
void CreateSquare (vtkPoints *pts, vtkCellArray *lines, vtkCellArray *polys, vtkUnsignedCharArray *colors)
void CreateCircle (vtkPoints *pts, vtkCellArray *lines, vtkCellArray *polys, vtkUnsignedCharArray *colors)
void CreateDiamond (vtkPoints *pts, vtkCellArray *lines, vtkCellArray *polys, vtkUnsignedCharArray *colors)
void CreateArrow (vtkPoints *pts, vtkCellArray *lines, vtkCellArray *polys, vtkUnsignedCharArray *colors)
void CreateThickArrow (vtkPoints *pts, vtkCellArray *lines, vtkCellArray *polys, vtkUnsignedCharArray *colors)
void CreateHookedArrow (vtkPoints *pts, vtkCellArray *lines, vtkCellArray *polys, vtkUnsignedCharArray *colors)

Protected Attributes

float Center [3]
float Scale
float Scale2
float Color [3]
int Filled
int Dash
int Cross
int GlyphType
float RotationAngle
unsigned char RGB [3]

Detailed Description

create 2D glyphs represented by vtkPolyData.

Date:
2000/12/10 20:09:02
Revision:
1.5
Thanks:
Tim Smith who sponsored and encouraged the development of this class.
vtkGlyphSource2D can generate a family of 2D glyphs each of which lies in the x-y plane (i.e., the z-coordinate is zero). The class is a helper class to be used with vtkGlyph2D and vtkXYPlotActor.

To use this class, specify the glyph type to use and its attributes. Attributes include its position (i.e., center point), scale, color, and whether the symbol is filled or not (a polygon or closed line sequence). You can also put a short line through the glyph running from -x to +x (the glyph looks like it's on a line), or a cross.

Examples:
vtkGlyphSource2D (examples)

Definition at line 81 of file vtkGlyphSource2D.h.

Constructor & Destructor Documentation

vtkGlyphSource2D::vtkGlyphSource2D (    )  [protected]
 

vtkGlyphSource2D::~vtkGlyphSource2D (    )  [inline, protected]
 

Definition at line 155 of file vtkGlyphSource2D.h.

vtkGlyphSource2D::vtkGlyphSource2D (  const vtkGlyphSource2D &    )  [inline, protected]
 

Definition at line 156 of file vtkGlyphSource2D.h.

Member Function Documentation

virtual const char* vtkGlyphSource2D::GetClassName (    )  [virtual]
 

Return the class name as a string. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkPolyDataSource.

int vtkGlyphSource2D::IsTypeOf (  const char *    type )  [static]
 

Return 1 if this class type 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 vtkPolyDataSource.

virtual int vtkGlyphSource2D::IsA (  const char *    type )  [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 vtkPolyDataSource.

vtkGlyphSource2D* vtkGlyphSource2D::SafeDownCast (  vtkObject *    o )  [static]
 

Will cast the supplied object to vtkObject* is this is a safe operation (i.e., a safe downcast); otherwise NULL is returned. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkPolyDataSource.

void vtkGlyphSource2D::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 vtkSource.

vtkGlyphSource2D* vtkGlyphSource2D::New (    )  [static]
 

Construct a vertex glyph centered at the origin, scale 1.0, white in color, filled, with line segment passing through the point.

Reimplemented from vtkPolyDataSource.

virtual void vtkGlyphSource2D::SetCenter (  float   ,
float   ,
float   
)  [virtual]
 

Set the center of the glyph. By default the center is (0,0,0).

virtual void vtkGlyphSource2D::SetCenter (  float   [3] )  [virtual]
 

virtual float* vtkGlyphSource2D::GetCenter (    )  [virtual]
 

virtual void vtkGlyphSource2D::GetCenter (  float    data[3] )  [virtual]
 

virtual void vtkGlyphSource2D::SetScale (  float    )  [virtual]
 

Set the scale of the glyph. Note that the glyphs are designed to fit in the (1,1) rectangle.

virtual float vtkGlyphSource2D::GetScale (    )  [virtual]
 

virtual void vtkGlyphSource2D::SetScale2 (  float    )  [virtual]
 

Set the scale of optional portions of the glyph (e.g., the dash and cross is DashOn() and CrossOn()).

virtual float vtkGlyphSource2D::GetScale2 (    )  [virtual]
 

virtual void vtkGlyphSource2D::SetColor (  float   ,
float   ,
float   
)  [virtual]
 

Set the color of the glyph. The default color is white.

virtual void vtkGlyphSource2D::SetColor (  float   [3] )  [virtual]
 

virtual float* vtkGlyphSource2D::GetColor (    )  [virtual]
 

virtual void vtkGlyphSource2D::GetColor (  float    data[3] )  [virtual]
 

virtual void vtkGlyphSource2D::SetFilled (  int    )  [virtual]
 

Specify whether the glyph is filled (a polygon) or not (a closed polygon defined by line segments). This only applies to 2D closed glyphs.

virtual int vtkGlyphSource2D::GetFilled (    )  [virtual]
 

virtual void vtkGlyphSource2D::FilledOn (    )  [virtual]
 

virtual void vtkGlyphSource2D::FilledOff (    )  [virtual]
 

virtual void vtkGlyphSource2D::SetDash (  int    )  [virtual]
 

Specify whether a short line segment is drawn through the glyph. (This is in addition to the glyph. If the glyph type is set to "Dash" there is no need to enable this flag.)

virtual int vtkGlyphSource2D::GetDash (    )  [virtual]
 

virtual void vtkGlyphSource2D::DashOn (    )  [virtual]
 

virtual void vtkGlyphSource2D::DashOff (    )  [virtual]
 

virtual void vtkGlyphSource2D::SetCross (  int    )  [virtual]
 

Specify whether a cross is drawn as part of the glyph. (This is in addition to the glyph. If the glyph type is set to "Cross" there is no need to enable this flag.)

virtual int vtkGlyphSource2D::GetCross (    )  [virtual]
 

virtual void vtkGlyphSource2D::CrossOn (    )  [virtual]
 

virtual void vtkGlyphSource2D::CrossOff (    )  [virtual]
 

virtual void vtkGlyphSource2D::SetRotationAngle (  float    )  [virtual]
 

Specify an angle (in degrees) to rotate the glyph around the z-axis. Using this ivar, it is possible to generate rotated glyphs (e.g., crosses, arrows, etc.)

virtual float vtkGlyphSource2D::GetRotationAngle (    )  [virtual]
 

virtual void vtkGlyphSource2D::RotationAngleOn (    )  [virtual]
 

virtual void vtkGlyphSource2D::RotationAngleOff (    )  [virtual]
 

virtual void vtkGlyphSource2D::SetGlyphType (  int    )  [virtual]
 

Specify the type of glyph to generate.

virtual int vtkGlyphSource2D::GetGlyphType (    )  [virtual]
 

void vtkGlyphSource2D::SetGlyphTypeToNone (    )  [inline]
 

Definition at line 140 of file vtkGlyphSource2D.h.

void vtkGlyphSource2D::SetGlyphTypeToVertex (    )  [inline]
 

Definition at line 141 of file vtkGlyphSource2D.h.

void vtkGlyphSource2D::SetGlyphTypeToDash (    )  [inline]
 

Definition at line 142 of file vtkGlyphSource2D.h.

void vtkGlyphSource2D::SetGlyphTypeToCross (    )  [inline]
 

Definition at line 143 of file vtkGlyphSource2D.h.

void vtkGlyphSource2D::SetGlyphTypeToThickCross (    )  [inline]
 

Definition at line 144 of file vtkGlyphSource2D.h.

void vtkGlyphSource2D::SetGlyphTypeToTriangle (    )  [inline]
 

Definition at line 145 of file vtkGlyphSource2D.h.

void vtkGlyphSource2D::SetGlyphTypeToSquare (    )  [inline]
 

Definition at line 146 of file vtkGlyphSource2D.h.

void vtkGlyphSource2D::SetGlyphTypeToCircle (    )  [inline]
 

Definition at line 147 of file vtkGlyphSource2D.h.

void vtkGlyphSource2D::SetGlyphTypeToDiamond (    )  [inline]
 

Definition at line 148 of file vtkGlyphSource2D.h.

void vtkGlyphSource2D::SetGlyphTypeToArrow (    )  [inline]
 

Definition at line 149 of file vtkGlyphSource2D.h.

void vtkGlyphSource2D::SetGlyphTypeToThickArrow (    )  [inline]
 

Definition at line 150 of file vtkGlyphSource2D.h.

void vtkGlyphSource2D::SetGlyphTypeToHookedArrow (    )  [inline]
 

Definition at line 151 of file vtkGlyphSource2D.h.

void vtkGlyphSource2D::operator= (  const vtkGlyphSource2D &    )  [inline, protected]
 

Definition at line 157 of file vtkGlyphSource2D.h.

void vtkGlyphSource2D::Execute (    )  [protected, virtual]
 

Reimplemented from vtkSource.

void vtkGlyphSource2D::TransformGlyph (  vtkPoints *    pts )  [protected]
 

void vtkGlyphSource2D::ConvertColor (    )  [protected]
 

void vtkGlyphSource2D::CreateVertex (  vtkPoints *    pts,
vtkCellArray *    verts,
vtkUnsignedCharArray *    colors
)  [protected]
 

void vtkGlyphSource2D::CreateDash (  vtkPoints *    pts,
vtkCellArray *    lines,
vtkCellArray *    polys,
vtkUnsignedCharArray *    colors,
float    scale
)  [protected]
 

void vtkGlyphSource2D::CreateCross (  vtkPoints *    pts,
vtkCellArray *    lines,
vtkCellArray *    polys,
vtkUnsignedCharArray *    colors,
float    scale
)  [protected]
 

void vtkGlyphSource2D::CreateThickCross (  vtkPoints *    pts,
vtkCellArray *    lines,
vtkCellArray *    polys,
vtkUnsignedCharArray *    colors
)  [protected]
 

void vtkGlyphSource2D::CreateTriangle (  vtkPoints *    pts,
vtkCellArray *    lines,
vtkCellArray *    polys,
vtkUnsignedCharArray *    colors
)  [protected]
 

void vtkGlyphSource2D::CreateSquare (  vtkPoints *    pts,
vtkCellArray *    lines,
vtkCellArray *    polys,
vtkUnsignedCharArray *    colors
)  [protected]
 

void vtkGlyphSource2D::CreateCircle (  vtkPoints *    pts,
vtkCellArray *    lines,
vtkCellArray *    polys,
vtkUnsignedCharArray *    colors
)  [protected]
 

void vtkGlyphSource2D::CreateDiamond (  vtkPoints *    pts,
vtkCellArray *    lines,
vtkCellArray *    polys,
vtkUnsignedCharArray *    colors
)  [protected]
 

void vtkGlyphSource2D::CreateArrow (  vtkPoints *    pts,
vtkCellArray *    lines,
vtkCellArray *    polys,
vtkUnsignedCharArray *    colors
)  [protected]
 

void vtkGlyphSource2D::CreateThickArrow (  vtkPoints *    pts,
vtkCellArray *    lines,
vtkCellArray *    polys,
vtkUnsignedCharArray *    colors
)  [protected]
 

void vtkGlyphSource2D::CreateHookedArrow (  vtkPoints *    pts,
vtkCellArray *    lines,
vtkCellArray *    polys,
vtkUnsignedCharArray *    colors
)  [protected]
 

Member Data Documentation

float vtkGlyphSource2D::Center[3] [protected]
 

Definition at line 161 of file vtkGlyphSource2D.h.

float vtkGlyphSource2D::Scale [protected]
 

Definition at line 162 of file vtkGlyphSource2D.h.

float vtkGlyphSource2D::Scale2 [protected]
 

Definition at line 163 of file vtkGlyphSource2D.h.

float vtkGlyphSource2D::Color[3] [protected]
 

Definition at line 164 of file vtkGlyphSource2D.h.

int vtkGlyphSource2D::Filled [protected]
 

Definition at line 165 of file vtkGlyphSource2D.h.

int vtkGlyphSource2D::Dash [protected]
 

Definition at line 166 of file vtkGlyphSource2D.h.

int vtkGlyphSource2D::Cross [protected]
 

Definition at line 167 of file vtkGlyphSource2D.h.

int vtkGlyphSource2D::GlyphType [protected]
 

Definition at line 168 of file vtkGlyphSource2D.h.

float vtkGlyphSource2D::RotationAngle [protected]
 

Definition at line 169 of file vtkGlyphSource2D.h.

unsigned char vtkGlyphSource2D::RGB[3] [protected]
 

Definition at line 173 of file vtkGlyphSource2D.h.

The documentation for this class was generated from the following file:
Generated on Wed Nov 21 12:48:08 2001 for VTK by doxygen1.2.11.1 written by Dimitri van Heesch, © 1997-2001