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.

Method Summary
Camera	`__copy__()` Make a copy of this camera
	`addScriptLink(text, event)` Add a new script link to this Camera.
	`clearIpo()` Unlink the ipo from this camera data object.
	`clearScriptLinks(links)` Delete script links from this Camera.
float	`getClipEnd()` Get the clip end value.
float	`getClipStart()` Get the clip start value.
float	`getDrawSize()` Get the draw size value.
Ipo	`getIpo()` Get the Ipo associated with this camera data object, if any.
float	`getLens()` Get the lens value.
int	`getMode()` Get this Camera's mode flags.
string	`getName()` Get the name of this Camera Data object.
float	`getScale()` Get the scale value.
list	`getScriptLinks(event)` Get a list with this Camera's script links of type 'event'.
int	`getType()` Get this Camera's type.
	`insertIpoKey(keytype)` Inserts keytype values in camera ipo at curframe.
	`setClipEnd(clipend)` Set the clip end value.
	`setClipStart(clipstart)` Set the clip start value.
	`setDrawSize(drawsize)` Set the draw size value.
	`setIpo(ipo)` Link an ipo to this camera data object.
	`setLens(lens)` Set the lens value.
	`setMode(mode1, mode2)` Set this Camera's mode flags.
	`setName(name)` Set the name of this Camera Data object.
	`setScale(scale)` Set the scale value.
	`setType(type)` Set this Camera's type.

Instance Variable Summary
	`alpha`: The PassePart alpha [0.0, 1.0].
	`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.
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.
	`mode`: The mode flags: ORed value: 'showLimits':1, 'showMist':2.
	`name`: The Camera Data name.
	`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].
	`type`: The Camera type: 'persp' or 'ortho'

Method Details

copy()

Make a copy of this camera

Returns:: a copy of this camera
(type=Camera)

addScriptLink(text, event)

Add a new script link to this Camera.

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

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.

clearScriptLinks(links=None)

Delete script links from this Camera. 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)

getClipEnd()

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

Returns:: float

getClipStart()

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

Returns:: float

getDrawSize()

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

Returns:: float

getIpo()

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

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

getLens()

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

Returns:: float

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

getMode()

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

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

getName()

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

Returns:: string

getScale()

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

Returns:: float

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

getScriptLinks(event)

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

Parameters:: event - "FrameChanged", "Redraw" or "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)

getType()

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

Returns:: 0 for 'persp' or 1 for 'ortho'.
(type=int)

insertIpoKey(keytype)

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

Parameters:: keytype - -LENS -CLIPPING
(type=Integer)

Returns:: py_none

setClipEnd(clipend)

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

Parameters:: clipend - The new clip end value.
(type=float)

setClipStart(clipstart)

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

Parameters:: clipstart - The new lens value.
(type=float)

setDrawSize(drawsize)

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

Parameters:: drawsize - The new draw size value.
(type=float)

setIpo(ipo)

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

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

setLens(lens)

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

Parameters:: lens - The new lens value.
(type=float)

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

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 - A mode flag: 'showLimits' or 'showMist'.
(type=string); mode2 - A mode flag: 'showLimits' or 'showMist'.
(type=string)

setName(name)

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

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

setScale(scale)

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

Parameters:: scale - The new scale value in [0.01, 1000.00].
(type=float)

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

setType(type)

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

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

Instance Variable Details

alpha

The PassePart alpha [0.0, 1.0].

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.

ipo

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

Type:: Blender Ipo

lens

The lens value in [1.0, 250.0], only relevant to *persp* cameras.

mode

The mode flags: ORed value: 'showLimits':1, 'showMist':2.

name

The Camera Data name.

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].

type

The Camera type: 'persp' or 'ortho'

Generated by Epydoc 2.1 on Sun Feb 11 13:30:18 2007

http://epydoc.sf.net