1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103
|
Usage
vtkRegularPolygonSource is a source object that creates a
single n-sided polygon and/or polyline. The polygon is
centered at a specified point, orthogonal to a specified
normal, and with a circumscribing radius set by the user.
The user can also specify the number of sides of the polygon
ranging from [3,N].
This object can be used for seeding streamlines or defining
regions for clipping/cutting.
To create an instance of class vtkRegularPolygonSource,
simply invoke its constructor as follows
obj = vtkRegularPolygonSource
Methods
The class vtkRegularPolygonSource has several methods that
can be used. They are listed below. Note that the
documentation is translated automatically from the VTK
sources, and may not be completely intelligible. When in
doubt, consult the VTK website. In the methods listed below,
obj is an instance of the vtkRegularPolygonSource class.
* string = obj.GetClassName () - Standard methods for
instantiation, obtaining type and printing instance
values.
* int = obj.IsA (string name) - Standard methods for
instantiation, obtaining type and printing instance
values.
* vtkRegularPolygonSource = obj.NewInstance () - Standard
methods for instantiation, obtaining type and printing
instance values.
* vtkRegularPolygonSource = obj.SafeDownCast (vtkObject o) -
Standard methods for instantiation, obtaining type and
printing instance values.
* obj.SetNumberOfSides (int ) - Set/Get the number of sides
of the polygon. By default, the number of sides is set to
six.
* int = obj.GetNumberOfSidesMinValue () - Set/Get the number
of sides of the polygon. By default, the number of sides
is set to six.
* int = obj.GetNumberOfSidesMaxValue () - Set/Get the number
of sides of the polygon. By default, the number of sides
is set to six.
* int = obj.GetNumberOfSides () - Set/Get the number of
sides of the polygon. By default, the number of sides is
set to six.
* obj.SetCenter (double , double , double ) - Set/Get the
center of the polygon. By default, the center is set at
the origin (0,0,0).
* obj.SetCenter (double a[3]) - Set/Get the center of the
polygon. By default, the center is set at the origin
(0,0,0).
* double = obj. GetCenter () - Set/Get the center of the
polygon. By default, the center is set at the origin
(0,0,0).
* obj.SetNormal (double , double , double ) - Set/Get the
normal to the polygon. The ordering of the polygon will be
counter-clockwise around the normal (i.e., using the
right-hand rule). By default, the normal is set to
(0,0,1).
* obj.SetNormal (double a[3]) - Set/Get the normal to the
polygon. The ordering of the polygon will be counter-
clockwise around the normal (i.e., using the right-hand
rule). By default, the normal is set to (0,0,1).
* double = obj. GetNormal () - Set/Get the normal to the
polygon. The ordering of the polygon will be counter-
clockwise around the normal (i.e., using the right-hand
rule). By default, the normal is set to (0,0,1).
* obj.SetRadius (double ) - Set/Get the radius of the
polygon. By default, the radius is set to 0.5.
* double = obj.GetRadius () - Set/Get the radius of the
polygon. By default, the radius is set to 0.5.
* obj.SetGeneratePolygon (int ) - Control whether a polygon
is produced. By default, GeneratePolygon is enabled.
* int = obj.GetGeneratePolygon () - Control whether a
polygon is produced. By default, GeneratePolygon is
enabled.
* obj.GeneratePolygonOn () - Control whether a polygon is
produced. By default, GeneratePolygon is enabled.
* obj.GeneratePolygonOff () - Control whether a polygon is
produced. By default, GeneratePolygon is enabled.
* obj.SetGeneratePolyline (int ) - Control whether a
polyline is produced. By default, GeneratePolyline is
enabled.
* int = obj.GetGeneratePolyline () - Control whether a
polyline is produced. By default, GeneratePolyline is
enabled.
* obj.GeneratePolylineOn () - Control whether a polyline is
produced. By default, GeneratePolyline is enabled.
* obj.GeneratePolylineOff () - Control whether a polyline is
produced. By default, GeneratePolyline is enabled.
* FreeMat_Documentation
* Visualization_Toolkit_Graphics_Classes
* Generated on Thu Jul 25 2013 17:18:32 for FreeMat by
doxygen_ 1.8.1.1
|