Welcome to mirror list, hosted at ThFree Co, Russian Federation.

MeshPrimitives.py « doc « api2_2x « python « blender « source - git.blender.org/blender.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
blob: 4fb53ab4536782de6e1c56fe252d61fbd0a939f6 (plain)
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
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
# Blender.Mesh.Primitives module

"""
The Blender.Mesh.Primitives submodule.

B{New}:

Mesh Primitive Data
===================

This submodule provides access Blender's mesh primitives.  Each module 
function returns a BPy_Mesh object which wraps the mesh data.  This data can
then be manipulated using the L{Mesh} API.

Example::

  from Blender import *

  me = Mesh.Primitives.Cube(2.0)   # create a new cube of size 2
  sc = Scene.GetCurrent()          # get current scene
  sc.objects.new(me,'Mesh')        # add a new mesh-type object to the scene
  Window.RedrawAll()               # update windows
"""

def Plane(size=2.0):
  """
  Construct a filled planar mesh with 4 vertices.  The default size
  creates a 2 by 2 Blender unit plane, identical to the Blender UI.
  @type size: float
  @param size: optional size of the plane.
  @rtype: L{BPy_Mesh<Mesh>}
  @return: returns a mesh object.
  """

def Cube(size=2.0):
  """
  Construct a cube mesh.  The default size creates a cube with each face
  2 by 2 Blender units, identical to the Blender UI.
  @type size: float
  @param size: optional size of the cube.
  @rtype: L{BPy_Mesh<Mesh>}
  @return: returns a mesh object.
  """

def Circle(verts=32,diameter=2.0):
  """
  Construct a circle mesh.  The defaults create a circle with a
  diameter of 2 Blender units, identical to the Blender UI.
  @type verts: int
  @param verts: optional number of vertices for the circle.  
  Value must be in the range [3,100].
  @type diameter: float
  @param diameter: optional diameter of the circle.
  @rtype: L{BPy_Mesh<Mesh>}
  @return: returns a mesh object.
  """

def Cylinder(verts=32, diameter=2.0, length=2.0):
  """
  Construct a cylindrical mesh (ends filled).  The defaults create a
  cylinder with a diameter of 2 Blender units and length 2 units,
  identical to the Blender UI.
  @type verts: int
  @param verts: optional number of vertices in the cylinder's perimeter.
  Value must be in the range [3,100].
  @type diameter: float
  @param diameter: optional diameter of the cylinder.
  @type length: float
  @param length: optional length of the cylinder.
  @rtype: L{BPy_Mesh<Mesh>}
  @return: returns a mesh object.
  """

def Tube(verts=32, diameter=2.0, length=2.0):
  """
  Construct a cylindrical mesh (ends not filled).  The defaults create a
  cylinder with a diameter of 2 Blender units and length 2 units, identical
  to the Blender UI.
  @type verts: int
  @param verts: optional number of vertices in the tube's perimeter.
  Value must be in the range [3,100].
  @type diameter: float
  @param diameter: optional diameter of the tube.
  @type length: float
  @param length: optional length of the tube.
  @rtype: L{BPy_Mesh<Mesh>}
  @return: returns a mesh object.
  """

def Cone(verts=32, diameter=2.0, length=2.0):
  """
  Construct a conic mesh (ends filled).  The defaulte create a cone with a
  base diameter of 2 Blender units and length 2 units, identical to
  the Blender UI.
  @type verts: int
  @param verts: optional number of vertices in the cone's perimeter.
  Value must be in the range [3,100].
  @type diameter: float
  @param diameter: optional diameter of the cone.
  @type length: float
  @param length: optional length of the cone.
  @rtype: L{BPy_Mesh<Mesh>}
  @return: returns a mesh object.
  """

def Grid(xres=32, yres=32, size=2.0):
  """
  Construct a grid mesh.  The defaults create a 32 by 32 mesh of size 2
  Blender units, identical to the Blender UI.
  @type xres: int
  @param xres: optional grid size in the x direction.
  Value must be in the range [2,100].
  @type yres: int
  @param yres: optional grid size in the y direction.
  Value must be in the range [2,100].
  @type size: float
  @param size: optional size of the grid.
  @rtype: L{BPy_Mesh<Mesh>}
  @return: returns a mesh object.
  """

def UVsphere(segments=32, rings=32, diameter=2.0):
  """
  Construct a UV sphere mesh.  The defaults create a 32 by 32 sphere with
  a diameter of 2 Blender units, identical to the Blender UI.
  @type segments: int
  @param segments: optional number of longitudinal divisions.
  Value must be in the range [3,100].
  @type rings: int
  @param rings: optional number of latitudinal divisions.
  Value must be in the range [3,100].
  @type diameter: float
  @param diameter: optional diameter of the sphere.
  @rtype: L{BPy_Mesh<Mesh>}
  @return: returns a mesh object.
  """

def Icosphere(subdivisions=2, diameter=2.0):
  """
  Construct a Icosphere mesh.  The defaults create sphere with 2 subdivisions
  and diameter of 2 Blender units, identical to the Blender UI.
  @type subdivisions: int
  @param subdivisions: optional number of subdivisions.
  Value must be in the range [2,5].
  @type diameter: float
  @param diameter: optional diameter of the sphere.
  @rtype: L{BPy_Mesh<Mesh>}
  @return: returns a mesh object.
  """

def Monkey():
  """
  Construct a Suzanne mesh.  
  @rtype: L{BPy_Mesh<Mesh>}
  @return: returns a mesh object.
  """