Page Comparison

...

Methods

Name	Description
setStep	Sets the camera parameters that can change in an animation.
getStep	Gets the camera parameteres that can change in an animation.
setOrthoValues	Sets orthographic camera values.
getOrthoValues	Gets orthographic camera values.
getValues	Gets the camera parameters that cannot change in an animation.
setName	Sets camera name.
getName	Gets camera name.
setResolution	Sets camera resolution.
getResolution	Gets camera resolution.
setPixelAspect	Sets camera pixel aspect.
getPixelAspect	Gets camera pixel aspect.
setShutter	Sets camera shutter.
getShutter	Gets camera shutter.
setIso	Sets camera ISO.
getIso	Gets camera ISO.
setFilmSize	Sets camera film size.
getFilmSize	Gets camera film size.
setDiaphragm	Sets camera diaphragm.
getDiaphragm	Gets camera diaphragm.
setFPS	Sets camera FPS.
getFPS	Gets camera FPS.
setScreenRegion	Defines a render region for the camera.
getScreenRegion	Gets render region defined.
setCutPlanes	Sets camera cut planes.
getCutPlanes	Gets camera cut planes.
setShiftLens	Sets camera shift lens.
getShiftLens	Gets camera shift lens.
setCustomBokeh	Defines a custom bokeh.
getCustomBokeh	Gets custom bokeh parameters.
setHide	Sets camera hidden status.
isHide	Gets camera hidden status.
setUuid	Sets camera unique ID. For custom purposes.
getUuid	Gets camera unique ID. For custom purposes.
setUserData	Internal use.
getUserData	Internal use.
setActive	Sets the active camera in case the scene have more than one.
setDirty	Internal use.
isDirty	Internal use.
Ccamera#free free	Destroys the camera.

Inherited methods

...

Language	Syntax
C++	byte getStep( dword iStep, Cpoint& origin, Cpoint& focalPoint, Cvector& up, real& focalLength, real& fStop )
Python	[ (Cvector ' origin', Cvector ' focalPoint', Cvector ' up', float ' focalLength', float ' fStop'] ) getStep( int step )

Parameters

...

0 = Error getting camera step values.

1 = Success.

Python

Tuple containing the camera parameters requested.

Anchor

	setorthovalues
	setorthovalues

...

Language	Syntax
C++	byte getOrthoValues( dword iStep, real& orthoX, real& orthoY, real& orthoZoom, real& focalLength, real& fStop )
Python	[ (float ' orthoX', float ' orthoY', float ' ortoZoom', float ' focalLength', float ' fStop' ] ) getOrthoValues( int iStep )

...

Type	Name	In/Out	Description
dword	iStep	in	Camera step requested.
real	orthoX	out	Camera position.
real	orthoY	out	Camera position.
real	orthoZoom	out	Camera zoom.
real	focalLength	out	Camera focal length.
real	fStop	out	Camera f-Stop.

Return value

C++

0 = Error getting ortho values.

1 = Success.

...

Python

Tuple containing the camera parameters requested.

Anchor

	getvalues
	getvalues

getValues

...

Type	Name	In/Out	Description
dword	nSteps	out	Number of steps.
real	shutter	out	Camera shutter (1/s).
real	filmWidth	out	Camera film width (mm).
real	filmHeight	out	Camera film height (mm).
real	iso	out	Camera ISO.
const char**	pDiaphragmType	out	Diaphragm type. Possible values: "CIRCULAR" and "POLYGONAL".
real	angle	out	Shutter angle. --TODO--
dword	nBlades	out	Number of diaphragm blades if pDiaphragmType is "POLYGONAL".
dword	fps	out	Frames per second.
dword	xRes	out	Resolution output width.
dword	yRes	out	Resolution output height.
real	pixelAspect	out	Pixel aspect ratio.
byte	projectionType	out	Camera projection type. 0 (perspective, default), 1 (front), 2 (top), 3 (left), 4 (back), 5 (bottom), 6 (right).

...

Language	Syntax
C++	byte getResolution( dword& xRes, dword& yRes)
Python	(x,y) getResolution()

Return value

C++

0 = Error getting camera resolution.

1 = Success.

Python

(x,y) = Tuple containing width and height.

...

Language	Syntax
C++	byte getPixelAspect( real& pixelAspect)
Python	float getPixelAspect()

Return value

C++

0 = Error getting pixel aspect.

1 = Success.

Python

Pixel aspect.

Anchor

	setshutter
	setshutter

...

Language	Syntax
C++	byte getShutter( real& shutter )
Python	float getShutter()

Return value

C++

0 = Error getting shutter.

1 = Success.

Python

Shutter.

Anchor

	setiso
	setiso

...

Language	Syntax
C++	byte getIso( real& iso )
Python	float getIso()

Return value

C++

0 = Error getting ISO.

1 = Success.

Python

ISO.

Anchor

	setfilmsize
	setfilmsize

...

Language	Syntax
C++	byte getFilmSize( real& filmWidth, real& filmHeight )
Python	(x,y) getFilmSize()

Return value

C++

0 = Error getting camera film size.

1 = Success.

Python

(x,y) = Tuple containing width and height.

...

Type	Name	In/Out	Description
const char*	pDiaphragmType	in	Diaphgragm type. Must be one of the following values: "CIRCULAR" or "POLYGONAL".
real	angle	in	Diaphgragm angle of "POLYGONAL" diaphragm. If pDiaphragmType is not "POLYGONAL", angle is set to 0.0.
dword	nBlades	in	Number of blades ( of "POLYGONAL" diaphragm). If pDiaphragmType is not "POLYGONAL", nBlades is set to 0.

Return value

0 = Error setting camera diaphgragm.

...

Language	Syntax
C++	byte getDiaphragm( const char** pDiaphragmType, real& angle, dword& nBlades )
Python	[ (str ' type', float ' angle', int ' nBlades' ] ) getDiaphragm()

Parameters

Type	Name	In/Out	Description
const char*	pDiaphragmType	out	Diaphgragm type. Can be one of the following values: "CIRCULAR" or "POLYGONAL".
real	angle	out	Diaphgragm angle. of "POLYGONAL" diaphragm. If pDiaphragmType is not "POLYGONAL", angle is 0.0.
dword	nBlades	out	Number of blades (if of "POLYGONAL" diaphragm). If pDiaphragmType is not "POLYGONAL", nBlades is 0.

Return value

C++

0 = Error getting camera diaphragm.

1 = Success.

Python

Tuple containing the requested diaphragm parameters.

Anchor

	setfps
	setfps

setFPS

...

Language	Syntax
C++	byte getFPS( real& fps )
Python	float getFPS()

Return value

C++

0 = Error getting FPS.

1 = Success.

Python

FPS.

Anchor

	setscreenregion
	setscreenregion

...

Language	Syntax
C++	byte getScreenRegion( dword& x1, dword& y1, dword& x2, dword& y2, char* pType )
Python	[ (int ' x1', int ' y1', int ' x2', int ' y2', str ' type' ] ) getScreenRegion()

Parameters

Type	Name	In/Out	Description
dword	x1	out	X-axis up-left edge of the region (in pixels)
dword	y1	out	Y-axis up-left edge of the region (in pixels)
dword	x2	out	X-axis down-right edge of the region (in pixels)
dword	y2	out	Y-axis down-right edge of the region (in pixels)
const char*	pRegionType	out	Region type. Must be one of the following values: "REGION" or "BLOW UP".

Return value

C++

0 = Error getting screen region.

1 = Success.

...

Python

Tuple containing the screen region values.

Anchor

	setcutplanes
	setcutplanes

setCutPlanes

Sets camera cut planes.

...

Language	Syntax
C++	byte getCutPlanes( real& zNear, real& zFar, bool& enabled )
Python	['(float zNear', 'float zFar', 'float enabled'] ) getCutPlanes()

Return value

C++

0 = Error getting camera cut planes.

1 = Success.

Python

Dictionary Tuple containing the "zNear", "zFar" and "enabled" cut planes" values.

Anchor

	setshiftlens
	setshiftlens

...

Gets camera shift lens.

Language	Syntax
C++	byte getShiftLens( real& xShift, real& yShift )
Python	['xShift','yShift'] getShiftLens()

...

getShiftLens( real& xShift, real& yShift )
Python	(float xShift, float yShift) getShiftLens()

Return value

C++

0 = Error getting camera shift lens.

1 = Success.

Python

Tuple containing "xShift" and "yShift".

Anchor

	setcustombokeh
	setcustombokeh

setCustomBokeh

Defines a custom bokeh.

Language	Syntax
C++	byte setCustomBokeh( const real& ratio, const real& angle, bool enabled )
Python	int setCustomBokeh( float ratio, float angle, bool enabled )

Return Value

0 = Error

1 = Success

Anchor

	getcustombokeh
	getcustombokeh

getCustomBokeh

Gets custom bokeh parameters.

Language	Syntax
C++	byte getCustomBokeh( real& ratio, real& angle, bool& enabled )
Python	(float ratio, float angle, bool enabled, int success) getCustomBokeh()

Return Value

C++

0 = Error getting camera shift lens.

1 = Success.

Python

Dictionary containing "xShift" and "yShift"Tuple containing custom bokeh parameters and function success value.

Anchor

	sethide
	sethide

setHide

...

Language	Syntax
C++	byte isHide( bool& hide )
Python	bool isHide()

Return value

C++

0 = Error getting camera shift lens.

1 = Success.

Python

Hidden status.

Anchor

	setuuid
	setuuid

...

0 = Error destroying the camera.

1 = Success.

Page Comparison

Versions Compared

Old Version 44

New Version Current

Key

Methods

Inherited methods

Parameters

Python

Return value

C++

Python

getValues

Return value

C++

Python

Return value

C++

Python

Return value

C++

Python

Return value

C++

Python

Return value

C++

Python

Return value

Parameters

Return value

C++

Python

setFPS

Return value

C++

Python

Parameters

Return value

C++

Python

setCutPlanes

Return value

C++

Python

Return value

C++

Python

setCustomBokeh

Return Value

getCustomBokeh

Return Value

C++

Python

setHide

Return value

C++

Python