Home       Trees       Index       Help   

Blender

Module Text3d :: Class Text3d
[frames | no frames]

Class Text3d

The Text3d object

This object gives access Blender's Font objects
Method Summary
None addFrame()
Adds a text frame.
module constant getAlignment()
Get the text3d's alignment value.
float getBevelAmount()
Get the Text3d's bevel resolution value.
float getDefaultResolution()
Return Default text resolution.
tuple of module constants getDrawMode()
Get the drawing mode (3d, front, and/or back) Gets the text3d's drawing modes.
float getExtrudeBevelDepth()
Get the text3d's ext2 value.
float getgetExtrudeDepth()
Get the text3d's ext1 value.
float getLineSeparation()
Get the text3d's ext2 value.
string getName()
Get the name of this Text3d object.
float getShear()
Get the text3d's shear value.
float getSize()
Get the text3d's size value.
float getSpacing()
Get the text3d's spacing value.
string getText()
Get text string for this object
  getUVordco()
Return whether UV coords are used for Texture mapping
float getWidth()
Get the Text3d's width value.
float getXoffset()
Get the text3d's Xoffset value.
float getYoffset()
Get the text3d's Yoffset value.
None removeFrame(index)
Removed the frame at this index
None setAlignment(align)
Set the text3d's Alignment value.
None setBevelAmount(bevelresol)
Set the Text3d's bevel resolution value.
None setDefaultResolution(resolu)
Sets Default text Resolution.
None setDrawMode(val)
Set the text3d's drawing mode.
None setExtrudeBevelDepth(ext2)
Set the text3d's ext2 value.
None setgetExtrudeDepth(ext1)
Set the text3d's ext1 value.
None setLineSeparation(sep)
Set the text3d's ext2 value.
  setName(name)
Set the name of this Text3d object.
None setShear(shear)
Set the text3d's shear value.
None setSize(size)
Set the text3d's size value.
None setSpacing(spacing)
Set the text3d's spacing value.
  setText(name)
Set the text string in this Text3d object
  setUVordco(val)
Set the font to use UV coords for Texture mapping
None setWidth(width)
Set the Text3d's width value.
None setXoffset(xof)
Set the text3d's Xoffset value.
None setYoffset(yof)
Set the text3d's Yoffset value.

Instance Variable Summary
  activeFrame: The active frame for this text data.
bool fakeUser: When set to True, this datablock wont be removed, even if nothing is using it.
  frameHeight: The height of the active frame [0.0 - 50.0]
  frameWidth: The width of the active frame [0.0 - 50.0]
  frameX: The X position of the active frame [0.0 - 50.0]
  frameY: The Y position of the active frame [0.0 - 50.0]
string or None lib: path to the blend file this datablock is stored in (readonly).
string name: unique name within each blend file.
IDGroup properties: Returns an IDGroup reference to this datablocks's ID Properties.
bool tag: A temporary tag that to flag data as being used within a loop.
  totalFrames: The total number of text frames (read only)
int users: The number of users this datablock has.

Method Details

addFrame()

Adds a text frame. maximum number of frames is 255.
Returns:
None

getAlignment()

Get the text3d's alignment value. Uses module constants
  • LEFT
  • RIGHT
  • MIDDLE
  • FLUSH
Returns:
module constant

getBevelAmount()

Get the Text3d's bevel resolution value.
Returns:
float

getDefaultResolution()

Return Default text resolution.
Returns:
float

getDrawMode()

Get the drawing mode (3d, front, and/or back) Gets the text3d's drawing modes. Uses module constants
  • DRAW3D : "3D" is set
  • DRAWFRONT : "Front" is set
  • DRAWBACK : "Back" is set
Returns:
tuple of module constants

getExtrudeBevelDepth()

Get the text3d's ext2 value.
Returns:
float

getgetExtrudeDepth()

Get the text3d's ext1 value.
Returns:
float

getLineSeparation()

Get the text3d's ext2 value.
Returns:
float

getName()

Get the name of this Text3d object.
Returns:
string

getShear()

Get the text3d's shear value.
Returns:
float

getSize()

Get the text3d's size value.
Returns:
float

getSpacing()

Get the text3d's spacing value.
Returns:
float

getText()

Get text string for this object
Returns:
string

getUVordco()

Return whether UV coords are used for Texture mapping

getWidth()

Get the Text3d's width value.
Returns:
float

getXoffset()

Get the text3d's Xoffset value.
Returns:
float

getYoffset()

Get the text3d's Yoffset value.
Returns:
float

removeFrame(index)

Removed the frame at this index
Returns:
None

setAlignment(align)

Set the text3d's Alignment value. Uses module constants
  • LEFT
  • RIGHT
  • MIDDLE
  • FLUSH
Parameters:
align - The new text3d's Alignment value.
           (type=module constant)
Returns:
None

setBevelAmount(bevelresol)

Set the Text3d's bevel resolution value.
Parameters:
bevelresol - The new Curve's bevel resolution value.
           (type=float)
Returns:
None

setDefaultResolution(resolu)

Sets Default text Resolution.
Parameters:
resolu - The new Curve's U-resolution value.
           (type=float)
Returns:
None

setDrawMode(val)

Set the text3d's drawing mode. Uses module constants
  • DRAW3D
  • DRAWFRONT
  • DRAWBACK
Parameters:
val - The Text3d's modes. See getDrawMode for the meaning of the constants.
           (type=single module constant or tuple of module constants)
Returns:
None

setExtrudeBevelDepth(ext2)

Set the text3d's ext2 value.
Parameters:
ext2 - The new text3d's ext2 value.
           (type=float)
Returns:
None

setgetExtrudeDepth(ext1)

Set the text3d's ext1 value.
Parameters:
ext1 - The new text3d's ext1 value.
           (type=float)
Returns:
None

setLineSeparation(sep)

Set the text3d's ext2 value.
Parameters:
sep - The new text3d's separation value.
           (type=float)
Returns:
None

setName(name)

Set the name of this Text3d object.
Parameters:
name - The new name.
           (type=string)
Returns:
None

setShear(shear)

Set the text3d's shear value.
Parameters:
shear - The new text3d's shear value.
           (type=float)
Returns:
None

setSize(size)

Set the text3d's size value.
Parameters:
size - The new text3d's size value.
           (type=float)
Returns:
None

setSpacing(spacing)

Set the text3d's spacing value.
Parameters:
spacing - The new text3d's spacing value.
           (type=float)
Returns:
None

setText(name)

Set the text string in this Text3d object
Parameters:
name - The new text string for this object.
           (type=string)
Returns:
None

setUVordco(val)

Set the font to use UV coords for Texture mapping

setWidth(width)

Set the Text3d's width value.
Parameters:
width - The new text3d's width value.
           (type=float)
Returns:
None

setXoffset(xof)

Set the text3d's Xoffset value.
Parameters:
xof - The new text3d's Xoffset value.
           (type=float)
Returns:
None

setYoffset(yof)

Set the text3d's Yoffset value.
Parameters:
yof - The new text3d's Yoffset value.
           (type=float)
Returns:
None

Instance Variable Details

activeFrame

The active frame for this text data.

fakeUser

When set to True, this datablock wont be removed, even if nothing is using it. All data has this disabled by default except for Actions.
Type:
bool

frameHeight

The height of the active frame [0.0 - 50.0]

frameWidth

The width of the active frame [0.0 - 50.0]

frameX

The X position of the active frame [0.0 - 50.0]

frameY

The Y position of the active frame [0.0 - 50.0]

lib

path to the blend file this datablock is stored in (readonly).

lib will be None unless you are using external blend files with (File, Append/Link)

Note: the path may be relative, to get the full path use Blender.sys.expandpath
Type:
string or None

name

unique name within each blend file.

The name is case sensitive and 21 characters maximum length.

Note: a blend file may have naming collisions when external library data is used, be sure to check the value of lib.

Note: Setting a value longer then 21 characters will be shortened
Type:
string

properties

Returns an IDGroup reference to this datablocks's ID Properties.
Type:
IDGroup

tag

A temporary tag that to flag data as being used within a loop. always set all tags to True or False before using since blender uses this flag for its own internal operations.
Type:
bool

totalFrames

The total number of text frames (read only)

users

The number of users this datablock has. (readonly) Zero user datablocks are de-allocated after reloading and saving.
Type:
int

   Home       Trees       Index       Help   

Blender

Generated by Epydoc 2.1 on Thu May 10 20:31:59 2007 http://epydoc.sf.net