Trees       Indices       Help   
Module Text3d :: Class Text3d
[hide private]
[frames] | no frames]

Class Text3d

source code

The Text3d object

This object gives access Blender's Font objects

Instance Methods [hide private]
string
getName()
Get the name of this Text3d object.		 source code
 
setName(name)
Set the name of this Text3d object.		 source code
string
getText()
Get text string for this object		 source code
 
setText(name)
Set the text string in this Text3d object		 source code
tuple of module constants
getDrawMode()
Get the drawing mode (3d, front, and/or back) Gets the text3d's drawing modes.		 source code
None
setDrawMode(val)
Set the text3d's drawing mode.		 source code
 
getUVordco()
Return whether UV coords are used for Texture mapping		 source code
 
setUVordco(val)
Set the font to use UV coords for Texture mapping		 source code
float
getBevelAmount()
Get the Text3d's bevel resolution value.		 source code
None
setBevelAmount(bevelresol)
Set the Text3d's bevel resolution value.		 source code
float
getDefaultResolution()
Return Default text resolution.		 source code
None
setDefaultResolution(resolu)
Sets Default text Resolution.		 source code
float
getWidth()
Get the Text3d's width value.		 source code
None
setWidth(width)
Set the Text3d's width value.		 source code
float
getExtrudeDepth()
Get the text3d's ext1 value.		 source code
None
setExtrudeDepth(ext1)
Set the text3d's ext1 value.		 source code
float
getExtrudeBevelDepth()
Get the text3d's ext2 value.		 source code
None
setExtrudeBevelDepth(ext2)
Set the text3d's ext2 value.		 source code
float
getShear()
Get the text3d's shear value.		 source code
None
setShear(shear)
Set the text3d's shear value.		 source code
float
getSize()
Get the text3d's size value.		 source code
None
setSize(size)
Set the text3d's size value.		 source code
float
getLineSeparation()
Get the text3d's ext2 value.		 source code
None
setLineSeparation(sep)
Set the text3d's ext2 value.		 source code
float
getSpacing()
Get the text3d's spacing value.		 source code
None
setSpacing(spacing)
Set the text3d's spacing value.		 source code
float
getXoffset()
Get the text3d's Xoffset value.		 source code
None
setXoffset(xof)
Set the text3d's Xoffset value.		 source code
float
getYoffset()
Get the text3d's Yoffset value.		 source code
None
setYoffset(yof)
Set the text3d's Yoffset value.		 source code
module constant
getAlignment()
Get the text3d's alignment value.		 source code
None
setAlignment(align)
Set the text3d's Alignment value.		 source code
int
getMaterial(index)
get the material index of a character.		 source code
None
setMaterial(index, material_index)
Set a characters material.		 source code
None
addFrame()
Adds a text frame.		 source code
None
removeFrame(index)
Removed the frame at this index		 source code
Instance Variables [hide private]
  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 [hide private]

setName(name)

source code 

Set the name of this Text3d object.

Parameters:
  • name (string) - The new name.
Returns:
None

setText(name)

source code 

Set the text string in this Text3d object

Parameters:
  • name (string) - The new text string for this object.
Returns:
None

getDrawMode()

source code 

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

setDrawMode(val)

source code 

Set the text3d's drawing mode. Uses module constants

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

setBevelAmount(bevelresol)

source code 

Set the Text3d's bevel resolution value.

Parameters:
  • bevelresol (float) - The new Curve's bevel resolution value.
Returns: None

setDefaultResolution(resolu)

source code 

Sets Default text Resolution.

Parameters:
  • resolu (float) - The new Curve's U-resolution value.
Returns: None

setWidth(width)

source code 

Set the Text3d's width value.

Parameters:
  • width (float) - The new text3d's width value.
Returns: None

setExtrudeDepth(ext1)

source code 

Set the text3d's ext1 value.

Parameters:
  • ext1 (float) - The new text3d's ext1 value.
Returns: None

setExtrudeBevelDepth(ext2)

source code 

Set the text3d's ext2 value.

Parameters:
  • ext2 (float) - The new text3d's ext2 value.
Returns: None

setShear(shear)

source code 

Set the text3d's shear value.

Parameters:
  • shear (float) - The new text3d's shear value.
Returns: None

setSize(size)

source code 

Set the text3d's size value.

Parameters:
  • size (float) - The new text3d's size value.
Returns: None

setLineSeparation(sep)

source code 

Set the text3d's ext2 value.

Parameters:
  • sep (float) - The new text3d's separation value.
Returns: None

setSpacing(spacing)

source code 

Set the text3d's spacing value.

Parameters:
  • spacing (float) - The new text3d's spacing value.
Returns: None

setXoffset(xof)

source code 

Set the text3d's Xoffset value.

Parameters:
  • xof (float) - The new text3d's Xoffset value.
Returns: None

setYoffset(yof)

source code 

Set the text3d's Yoffset value.

Parameters:
  • yof (float) - The new text3d's Yoffset value.
Returns: None

getAlignment()

source code 

Get the text3d's alignment value. Uses module constants

  • LEFT
  • RIGHT
  • MIDDLE
  • FLUSH
Returns: module constant

setAlignment(align)

source code 

Set the text3d's Alignment value. Uses module constants

  • LEFT
  • RIGHT
  • MIDDLE
  • FLUSH
Parameters:
  • align (module constant) - The new text3d's Alignment value.
Returns: None

getMaterial(index)

source code 

get the material index of a character.

Parameters:
  • index (int) - the index of the character in a string
Returns: int
the material index if the character

setMaterial(index, material_index)

source code 

Set a characters material.

Parameters:
  • index (int) - the index of the character in a string
  • material_index (int) - the material index set set the character.
Returns: None

Note: after changing this youll need to update the object with object.makeDisplayList() to see the changes.

addFrame()

source code 

Adds a text frame. maximum number of frames is 255.

Returns: None

Instance Variable Details [hide private]

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

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

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

users

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

   Trees       Indices       Help   
Generated by Epydoc 3.0.1 on Fri Oct 24 10:23:53 2008 http://epydoc.sourceforge.net