A little editing on the doc for the newest member of our Bpy module familily: Text3d.

This commit is contained in:
Stephen Swaney
2005-03-13 13:17:59 +00:00
parent 7d520a16c4
commit 8c564af147
2 changed files with 18 additions and 16 deletions

View File

@@ -36,6 +36,7 @@ The Blender Python API Reference
- L{Render}
- L{Sound}
- L{Text}
- L{Text3d} (new)
- L{Texture}
- L{Types}
- L{Window}

View File

@@ -4,7 +4,7 @@
The Blender.Text3d submodule.
Text3d Objects
============
==============
This module provides access to B{Font} objects in Blender.
@@ -12,12 +12,12 @@ Example::
import Blender
from Blender import Curve, Object, Scene, Text3d
#
txt = Text3d.New("MyText") # create a new Text3d object
txt = Text3d.New("MyText") # create a new Text3d object called MyText
cur = Scene.getCurrent() # get current scene
ob = Object.New('Text') # make curve object
ob.link(txt) # link curve data with this object
ob = Object.New('Text') # make curve object
ob.link(txt) # link curve data with this object
cur.link(ob) # link object into scene
ob.makeDisplayList()
ob.makeDisplayList() # rebuild the display list for this object
Window.RedrawAll()
"""
@@ -25,7 +25,7 @@ def New (name = None):
"""
Create a new Text3d object.
@type name: string
@param name: The Text3d name.
@param name: The name for the new object..
@rtype: Blender Text3d
@return: The created Text3d Data object.
"""
@@ -43,8 +43,8 @@ def Get (name = None):
class Text3d:
"""
The Text3d object
===============
This object gives access to Text3ds in Blender.
=================
This object gives access Blender's B{Font} objects
@cvar name: The Text3d name.
@cvar filename: The filename of the file loaded into this Text.
@cvar mode: The follow_mode flag: if 1 it is 'on'; if 0, 'off'.
@@ -57,24 +57,25 @@ class Text3d:
@rtype: string
"""
def setName(name):
def setName( name ):
"""
Set the name of this Text3d object.
@type name: string
@param name: The new name.
@returns: PyNone
"""
def getText(data):
def getText():
"""
Get string text of Text3d object
@type data: string
@param data: The string name of Text3d.
Get text string for this object
@rtype: string
"""
def setText(name):
def setText( name ):
"""
Set string text to be redering in Text3d object
Set the text string in this Text3d object
@type name: string
@param name: The string name of Text3d.
@param name: The new text string for this object.
@returns: PyNone
"""