Module World :: Class World

Class World

The World object

This object gives access to generic data from all worlds in Blender. Its attributes depend upon its type.

Method Summary
	`addScriptLink(text, event)` Add a new script link to this World.
	`clearIpo()` Unlink the ipo from this world object.
	`clearScriptLinks(links)` Delete script links from this World :).
list of three floats	`getAmb()` Retrieves the ambient color of a world object.
list of three floats	`getHor()` Retrieves the horizon color of a world object.
Ipo	`getIpo()` Get the Ipo associated with this world object, if any.
list of four floats	`getMist()` Retrieves the mist parameters of a world object.
int	`getMistype()` Retrieves the mist type of a world object.
int	`getMode()` Retrieves the mode of a world object.
string	`getName()` Retrieves the name of a world object
float	`getRange()` Retrieves the range parameter of a world object.
list	`getScriptLinks(event)` Get a list with this World's script links of type 'event'.
int	`getSkytype()` Retrieves the skytype of a world object.
list of nine floats	`getStar()` Retrieves the star parameters of a world object.
list of three floats	`getZen()` Retrieves the zenith color of a world object.
	`insertIpoKey(keytype)` Inserts keytype values in world ipo at curframe.
PyNone	`setAmb(amb)` Sets the ambient color of a world object.
PyNone	`setCurrent()` Make this world active in the current scene.
PyNone	`setHor(hor)` Sets the horizon color of a world object.
	`setIpo(ipo)` Link an ipo to this world object.
PyNone	`setMist(mist)` Sets the mist parameters of a world object.
PyNone	`setMistype(mistype)` Sets the mist type of a world object.
PyNone	`setMode(mode)` Sets the mode of a world object.
PyNone	`setName(name)` Sets the name of a world object.
PyNone	`setRange(range)` Sets the range parameter of a world object.
PyNone	`setSkytype(skytype)` Sets the skytype of a world object.
PyNone	`setStar(star)` Sets the star parameters of a world object.
PyNone	`setZen(zen)` Sets the zenith color of a world object.

Instance Variable Summary
	`amb`: the ambient color of a world object.
	`hor`: the horizon color of a world object.
Blender Ipo	`ipo`: The world type ipo linked to this world object.
	`mist`: the mist parameters of a world object.
	`mistype`: type of mist : O : quadratic; 1 : linear; 2 : square
	`mode`:
	`name`: the name of the world.
	`skytype`: type of the sky.
	`star`: the star parameters of a world object.
	`zen`: the zenith color of a world object.

Method Details

addScriptLink(text, event)

Add a new script link to this World.

Parameters:: text - the name of an existing Blender Text.
(type=string); event - "FrameChanged", "Redraw" or "Render".
(type=string)

clearIpo()

Unlink the ipo from this world object.

Returns:: True if there was an ipo linked or False otherwise.

clearScriptLinks(links=None)

Delete script links from this World :). If no list is specified, all script links are deleted.

Parameters:: links - None (default) or a list of Blender Text names.
(type=list of strings)

getAmb()

Retrieves the ambient color of a world object. This color is a list of 3 floats.

Returns:: the ambient color of the world object.
(type=list of three floats)

getHor()

Retrieves the horizon color of a world object. This color is a list of 3 floats.

Returns:: the horizon color of the world object.
(type=list of three floats)

getIpo()

Get the Ipo associated with this world object, if any.

Returns:: the wrapped ipo or None.
(type=Ipo)

getMist()

Retrieves the mist parameters of a world object. It is a list of four floats : intensity of the mist start of the mist end of the mist height of the mist

Returns:: the mist parameters
(type=list of four floats)

getMistype()

Retrieves the mist type of a world object. The mist type is an integer 0 : quadratic; 1 : linear; 2 : square.

Returns:: the mistype of the world object.
(type=int)

getMode()

Retrieves the mode of a world object. The mode is a combination of 5 bits:

Bit 0 : mist simulation
Bit 1 : starfield simulation
Bit 2,3 : reserved
Bit 4 : ambient occlusion

Returns:: the mode of the world object.
(type=int)

getName()

Retrieves the name of a world object

Returns:: the name of the world object.
(type=string)

getRange()

Retrieves the range parameter of a world object.

Returns:: the range
(type=float)

getScriptLinks(event)

Get a list with this World's script links of type 'event'.

Parameters:: event - "FrameChanged", "Redraw", "Render".
(type=string)

Returns:: a list with Blender Text names (the script links of the given 'event' type) or None if there are no script links at all.
(type=list)

getSkytype()

Retrieves the skytype of a world object. The skytype is a combination of 3 bits : Bit 0 : Blend; Bit 1 : Real; Bit 2 : paper.

Returns:: the skytype of the world object.
(type=int)

getStar()

Retrieves the star parameters of a world object. It is a list of nine floats : red component of the color green component of the color blue component of the color size of the stars minimal distance between the stars average distance between the stars variations of the stars color

Returns:: the star parameters
(type=list of nine floats)

getZen()

Retrieves the zenith color of a world object. This color is a list of 3 floats.

Returns:: the zenith color of the world object.
(type=list of three floats)

insertIpoKey(keytype)

Inserts keytype values in world ipo at curframe. Uses module constants.

Parameters:: keytype - -ZENTIH -HORIZON -MIST -STARS -OFFSET -SIZE
(type=Integer)

Returns:: py_none

setAmb(amb)

Sets the ambient color of a world object.

Parameters:: amb - the new ambient color.
(type=list of three floats)

Returns:: PyNone
(type=PyNone)

setCurrent()

Make this world active in the current scene.

Returns:: PyNone
(type=PyNone)

setHor(hor)

Sets the horizon color of a world object.

Parameters:: hor - the new hor.
(type=list of three floats)

Returns:: PyNone
(type=PyNone)

setIpo(ipo)

Link an ipo to this world object.

Parameters:: ipo - a "camera data" ipo.
(type=Blender Ipo)

setMist(mist)

Sets the mist parameters of a world object. See getMist for the semantics of the parameter.

Parameters:: mist - the new mist parameters.
(type=list of 4 floats)

Returns:: PyNone
(type=PyNone)

setMistype(mistype)

Sets the mist type of a world object. See getMistype for the semantics of the parameter.

Parameters:: mistype - the new mist type.
(type=int)

Returns:: PyNone
(type=PyNone)

setMode(mode)

Sets the mode of a world object. See getMode for the semantics of the parameter.

Parameters:: mode - the new mode.
(type=int)

Returns:: PyNone
(type=PyNone)

setName(name)

Sets the name of a world object.

Parameters:: name - the new name.
(type=string)

Returns:: PyNone
(type=PyNone)

setRange(range)

Sets the range parameter of a world object.

Parameters:: range - the new range parameter
(type=float)

Returns:: PyNone
(type=PyNone)

setSkytype(skytype)

Sets the skytype of a world object. See getSkytype for the semantics of the parameter.

Parameters:: skytype - the new skytype.
(type=int)

Returns:: PyNone
(type=PyNone)

setStar(star)

Sets the star parameters of a world object. See getStar for the semantics of the parameter.

Parameters:: star - the new star parameters.
(type=list of 9 floats)

Returns:: PyNone
(type=PyNone)

setZen(zen)

Sets the zenith color of a world object.

Parameters:: zen - the new zenith color.
(type=list of three floats)

Returns:: PyNone
(type=PyNone)

Instance Variable Details

amb

the ambient color of a world object.

hor

the horizon color of a world object.

ipo

The world type ipo linked to this world object.

Type:: Blender Ipo

mist

the mist parameters of a world object. See getMist for the semantics of these parameters.

mistype

type of mist : O : quadratic; 1 : linear; 2 : square

mode

name

the name of the world.

skytype

type of the sky. Bit 0 : Blend; Bit 1 : Real; Bit 2 : paper.

star

the star parameters of a world object. See getStar for the semantics of these parameters.

zen

the zenith color of a world object.

Generated by Epydoc 2.1 on Thu Jul 13 16:50:05 2006

http://epydoc.sf.net