Module MeshPrimitives

Module MeshPrimitives

The Blender.Mesh.Primitives submodule.

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 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

Function Summary
`BPy_Mesh`	`Circle(verts, diameter)` Construct a circle mesh.
`BPy_Mesh`	`Cone(verts, diameter, length)` Construct a conic mesh (ends filled).
`BPy_Mesh`	`Cube(size)` Construct a cube mesh.
`BPy_Mesh`	`Cylinder(verts, diameter, length)` Construct a cylindrical mesh (ends filled).
`BPy_Mesh`	`Grid(xres, yres, size)` Construct a grid mesh.
`BPy_Mesh`	`Icosphere(subdivisions, diameter)` Construct a Icosphere mesh.
`BPy_Mesh`	`Monkey()` Construct a Suzanne mesh.
`BPy_Mesh`	`Plane(size)` Construct a filled planar mesh with 4 vertices.
`BPy_Mesh`	`Tube(verts, diameter, length)` Construct a cylindrical mesh (ends not filled).
`BPy_Mesh`	`UVsphere(segments, rings, diameter)` Construct a UV sphere mesh.

Function Details

Circle(verts=32, diameter=2.8283999999999998)

Construct a circle mesh. The defaults create a circle with a diameter of 2*sqrt(2) Blender units, identical to the Blender UI.

Parameters:: verts - optional number of vertices for the circle. Value must be in the range [3,100].
(type=int); diameter - optional diameter of the circle.
(type=float)

Returns:: returns a mesh object.
(type=BPy_Mesh)

Cone(verts=32, diameter=2.8283999999999998, length=1.0)

Construct a conic mesh (ends filled). The defaulte create a cone with a base diameter of 2*sqrt(2) Blender units and length 1 unit, identical to the Blender UI.

Parameters:: verts - optional number of vertices in the cone's perimeter. Value must be in the range [3,100].
(type=int); diameter - optional diameter of the cone.
(type=float); length - optional length of the cone.
(type=float)

Returns:: returns a mesh object.
(type=BPy_Mesh)

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.

Parameters:: size - optional size of the cube.
(type=float)

Returns:: returns a mesh object.
(type=BPy_Mesh)

Cylinder(verts=32, diameter=2.8283999999999998, length=1.0)

Construct a cylindrical mesh (ends filled). The defaults create a cylinder with a diameter of 2*sqrt(2) Blender units and length 1 unit, identical to the Blender UI.

Parameters:: verts - optional number of vertices in the cylinder's perimeter. Value must be in the range [3,100].
(type=int); diameter - optional diameter of the cylinder.
(type=float); length - optional length of the cylinder.
(type=float)

Returns:: returns a mesh object.
(type=BPy_Mesh)

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.

Parameters:: xres - optional grid size in the x direction. Value must be in the range [2,100].
(type=int); yres - optional grid size in the y direction. Value must be in the range [2,100].
(type=int); size - optional size of the grid.
(type=float)

Returns:: returns a mesh object.
(type=BPy_Mesh)

Icosphere(subdivisions=2, diameter=2.8282400000000001)

Construct a Icosphere mesh. The defaults create sphere with 2 subdivisions and diameter of 2*sqrt(2) Blender units, identical to the Blender UI.

Parameters:: subdivisions - optional number of subdivisions. Value must be in the range [2,5].
(type=int); diameter - optional diameter of the sphere.
(type=float)

Returns:: returns a mesh object.
(type=BPy_Mesh)

Monkey()

Construct a Suzanne mesh.

Returns:: returns a mesh object.
(type=BPy_Mesh)

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.

Parameters:: size - optional size of the plane.
(type=float)

Returns:: returns a mesh object.
(type=BPy_Mesh)

Tube(verts=32, diameter=2.8283999999999998, length=1.0)

Construct a cylindrical mesh (ends not filled). The defaults create a cylinder with a diameter of 2*sqrt(2) Blender units and length 1 unit, identical to the Blender UI.

Parameters:: verts - optional number of vertices in the tube's perimeter. Value must be in the range [3,100].
(type=int); diameter - optional diameter of the tube.
(type=float); length - optional length of the tube.
(type=float)

Returns:: returns a mesh object.
(type=BPy_Mesh)

UVsphere(segments=32, rings=32, diameter=2.8283999999999998)

Construct a UV sphere mesh. The defaults create a 32 by 32 sphere with a diameter of 2*sqrt(2) Blender units, identical to the Blender UI.

Parameters:: segments - optional number of longitudinal divisions. Value must be in the range [3,100].
(type=int); rings - optional number of latitudinal divisions. Value must be in the range [3,100].
(type=int); diameter - optional diameter of the sphere.
(type=float)

Returns:: returns a mesh object.
(type=BPy_Mesh)

Generated by Epydoc 2.1 on Sun Feb 11 13:30:19 2007

http://epydoc.sf.net