Module Camera :: Class Camera

Class Camera

The Camera Data object

This object gives access to Camera-specific data in Blender.

Warning: Most member variables assume values in some [Min, Max] interval. When trying to set them, the given parameter will be clamped to lie in that range: if val < Min, then val = Min, if val > Max, then val = Max.

Instance Methods

string

getName()
Get the name of this Camera Data object.

setName(name)
Set the name of this Camera Data object.

Ipo

getIpo()
Get the Ipo associated with this camera data object, if any.

setIpo(ipo)
Link an ipo to this camera data object.

clearIpo()
Unlink the ipo from this camera data object.

int

getType()
Get this Camera's type.

setType(type)
Set this Camera's type.

int

getMode()
Get this Camera's mode flags.

setMode(mode1=None, mode2=None)
Set this Camera's mode flags.

float

getLens()
Get the lens value.

setLens(lens)
Set the lens value.

float

getScale()
Get the scale value.

setScale(scale)
Set the scale value.

float

getClipStart()
Get the clip start value.

setClipStart(clipstart)
Set the clip start value.

float

getClipEnd()
Get the clip end value.

setClipEnd(clipend)
Set the clip end value.

float

getDrawSize()
Get the draw size value.

setDrawSize(drawsize)
Set the draw size value.

list

getScriptLinks(event)
Get a list with this Camera's script links of type 'event'.

clearScriptLinks(links=None)
Delete script links from this Camera.

addScriptLink(text, event)
Add a new script link to this Camera.

insertIpoKey(keytype)
Inserts keytype values in camera ipo at curframe.

Camera

__copy__()
Make a copy of this camera

Instance Variables
	alpha The PassePart alpha [0.0, 1.0].
	angle The lens value in degrees [7.323871, 172.847331], only relevant to persp cameras.
	clipEnd The clip end value in [1.0, 5000.0].
	clipStart The clip start value in [0.0, 100.0].
	dofDist The dofDist value in [0.0, 5000.0].
	drawLimits Toggle the option to show limits in the 3d view.
	drawMist Toggle the option to show mist in the 3d view.
	drawName Toggle the option to show the camera name in the 3d view.
	drawPassepartout Toggle the option to show pass part out in the 3d view.
	drawSize The display size for the camera an the 3d view [0.1, 10.0].
	drawTileSafe Toggle the option to show tile safe in the 3d view.
bool	fakeUser When set to True, this datablock wont be removed, even if nothing is using it.
Blender Ipo	ipo The "camera data" ipo linked to this camera data object.
	lens The lens value in [1.0, 250.0], only relevant to persp cameras.
string or None	lib path to the blend file this datablock is stored in (readonly).
	mode The mode flags: ORed value: 'showLimits':1, 'showMist':2.
string	name unique name within each blend file.
IDGroup	properties Returns an IDGroup reference to this datablocks's ID Properties.
	scale The scale value in [0.01, 1000.00], only relevant to ortho cameras.
	shiftX The horizontal offset of the camera [-2.0, 2.0].
	shiftY The vertical offset of the camera [-2.0, 2.0].
bool	tag A temporary tag that to flag data as being used within a loop.
	type The Camera type: 'persp' or 'ortho'
int	users The number of users this datablock has.

Method Details

getName()

Get the name of this Camera Data object. (deprecated) See the name attribute.

Returns: string

setName(name)

Set the name of this Camera Data object. (deprecated) See the name attribute.

Parameters:

name (string) - The new name.

getIpo()

Get the Ipo associated with this camera data object, if any. (deprecated)

Returns: Ipo: the wrapped ipo or None. (deprecated) See the ipo attribute.

setIpo(ipo)

Link an ipo to this camera data object. (deprecated) See the ipo attribute.

Parameters:

ipo (Blender Ipo) - a "camera data" ipo.

clearIpo()

Unlink the ipo from this camera data object. (deprecated) See the ipo attribute.

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

getType()

Get this Camera's type. (deprecated) See the type attribute.

Returns: int: 0 for 'persp' or 1 for 'ortho'.

setType(type)

Set this Camera's type. (deprecated) See the type attribute.

Parameters:

type (string) - The Camera type: 'persp' or 'ortho'.

getMode()

Get this Camera's mode flags. (deprecated) See the mode attribute.

Returns: int: OR'ed value: 'showLimits' is 1, 'showMist' is 2, or respectively, 01 and 10 in binary.

setMode(mode1=None, mode2=None)

Set this Camera's mode flags. Mode strings given are turned 'on'. (deprecated) See the mode attribute. Those not provided are turned 'off', so cam.setMode() -- without arguments -- turns off all mode flags for Camera cam.

Parameters:

mode1 (string) - A mode flag: 'showLimits' or 'showMist'.
mode2 (string) - A mode flag: 'showLimits' or 'showMist'.

getLens()

Get the lens value. (deprecated) See the lens attribute.

Returns: float

Warning: lens is only relevant for perspective (getType) cameras.

setLens(lens)

Set the lens value. (deprecated) See the lens attribute.

Parameters:

lens (float) - The new lens value.

Warning: lens is only relevant for perspective (type) cameras.

getScale()

Get the scale value. (deprecated) See the scale attribute.

Returns: float

Warning: scale is only relevant for ortho (type) cameras.

setScale(scale)

Set the scale value. (deprecated) See the scale attribute.

Parameters:

scale (float) - The new scale value in [0.01, 1000.00].

Warning: scale is only relevant for ortho (getType) cameras.

getClipStart()

Get the clip start value. (deprecated) See the clipStart attribute.

Returns: float

setClipStart(clipstart)

Set the clip start value. (deprecated) See the clipStart attribute.

Parameters:

clipstart (float) - The new lens value.

getClipEnd()

Get the clip end value. (deprecated) See the clipEnd attribute.

Returns: float

setClipEnd(clipend)

Set the clip end value. (deprecated) See the clipEnd attribute.

Parameters:

clipend (float) - The new clip end value.

getDrawSize()

Get the draw size value. (deprecated) See the drawSize attribute.

Returns: float

setDrawSize(drawsize)

Set the draw size value. (deprecated) See the drawSize attribute.

Parameters:

drawsize (float) - The new draw size value.

getScriptLinks(event)

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

Parameters:

event (string) - "FrameChanged", "Redraw" or "Render".

Returns: list

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

clearScriptLinks(links=None)

Delete script links from this Camera. If no list is specified, all script links are deleted.

Parameters:

links (list of strings) - None (default) or a list of Blender Text names.

addScriptLink(text, event)

Add a new script link to this Camera.

Parameters:

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

insertIpoKey(keytype)

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

Parameters:

keytype (Integer) - -LENS -CLIPPING

Returns:

py_none

copy()

Make a copy of this camera

Returns: Camera: a copy of this camera

Instance Variable Details

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

ipo

The "camera data" ipo linked to this camera data object. Set to None to clear the ipo.

Type:: Blender Ipo

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

users

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

Type:: int

Class Camera

The Camera Data object

getName()

setName(name)

getIpo()

setIpo(ipo)

clearIpo()

getType()

setType(type)

getMode()

setMode(mode1=None, mode2=None)

getLens()

setLens(lens)

getScale()

setScale(scale)

getClipStart()

setClipStart(clipstart)

getClipEnd()

setClipEnd(clipend)

getDrawSize()

setDrawSize(drawsize)

getScriptLinks(event)

clearScriptLinks(links=None)

addScriptLink(text, event)

insertIpoKey(keytype)

__copy__()

fakeUser

ipo

lib

name

tag

users

copy()