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.
free	Destroys the camera.

Inherited methods

Name	Description
isNull	Checks whether the object is null.

...

Type	Name	In/Out	Description
dword	iStep	in	Step number.
Cpoint	origin	in	Camera position.
Cpoint	focalPoint	in	Camera focus point.
Cvector	up	in	Camera up vector.
real	focalLenghtfocalLength	in	Camera focal lenght length (mm).
real	fStop	in	Camera f-Stop.
byte	focalLenghtNeedCorrectionfocalLengthNeedCorrection	in	Indicates wheter focal lenght length needs correction. Default value: 1 (true).

...

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

Type	Name	In/Out	Description
dword	iStep	in	Step requested.
Cpoint	origin	out	Camera position.
Cpoint	focalPoint	out	Camera target.
Cvector	up	out	Camera up vector.
real	focalLenghtfocalLength	out	Camera focal lenght length (mm).
real	fStop	out	Camera f-Stop.

...

0 = Error getting camera step values.

1 = Success.

Python

Tuple containing the camera parameters requested.

Anchor

	setorthovalues
	setorthovalues

setOrthoValues

...

Sets orthographic camera values. Cmaxwell::addCamera() was called with one of the following values for projectionType: 1 (front), 2 (top), 3 (left), 4 (back), 5 (bottom), or 6 (right).

Language	Syntax
C++	byte setOrthoValues( dword iStep, real orthoX, real orthoY, real orthoZoom, real focalLength, real fStop )
Python	int setOrthoValues( int iStep, float orthoX, float orthoY, float orthoZoom, float focalLength, float fStop )

...

Type	Name	In/Out	Description
dword	iStep	in	Camera step to be set.
real	orthoX	in	Camera position.
real	orthoY	in	Camera position.
real	orthoZoom	in	Camera zoom.
real	focalLenghtfocalLength	in	Camera focal lenghtlength.
real	fStop	in	Camera f-Stop.

...

Anchor

	getorthovalues
	getorthovalues

getOrthoValues

...

Sets orthographic camera values. Cmaxwell::addCamera() was called with one of the following values for projectionType: 1 (front), 2 (top), 3 (left), 4 (back), 5 (bottom), or 6 (right).

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 'focalLenght'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	focalLenghtfocalLength	out	Camera focal lenghtlength.
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

...

Language	Syntax
C++	const char* getValues( dword& nSteps, real& shutter, real& filmWidth, real& filmHeight, real& iso, const char** pDiaphragmType, real& angle, dword& nBlades, dword& fps, dword& xRes, dword& yRes, real& pixelAspect, byte& projectionType );
Python	[int 'nSteps', float 'shutter', float 'filmWidth', float 'filmHeight', float 'iso', str 'DiaphragmType', float 'angle', int 'nBlades', int 'fps', int 'xRes', int 'yRes', float 'pixelAspect', int 'projectionType'] 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 setName( const char* pName );
Python	int setName( str name );

Return value

0 = Error setting camera name.

...

Language	Syntax
C++	const char* getName();
Python	str getName();

Anchor

	setresolution
	setresolution

...

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.

Anchor

	setfilmsizesetpixelaspectsetfilmsize
	setpixelaspect

...

setPixelAspect

Sets camera film size ( 0.001 - 10000.0 meters ). Default = 0.035 x 0.024.

...

pixel aspect.

setFilmSize filmWidth, real filmHeight setFilmSize filmWidth, float filmHeight

Language	Syntax
C++	byte
setPixelAspect( real
pixelAspect )
Python	int
setPixelAspect( float
pixelAspext )

Return value

0 = Error setting film sizepixel aspect.

1 = Success.

Anchor

	getfilmsizegetpixelaspectgetfilmsize
	getpixelaspect

...

getPixelAspect

Gets camera film sizepixel aspect.

getFilmSize filmWidth, real& filmHeight (x,y) getFilmSize()

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

Return value

C++

0 = Error getting camera film sizepixel aspect.

1 = Success.

Python

(x,y) = Tuple containing width and heightPixel aspect.

Anchor

	setdiaphragmsetshuttersetdiaphragm
	setshutter

...

setShutter

Sets camera diaphragm shutter.

setDiaphragm const char* pDiaphragmType, real angle, dword nBlades setDiaphgragm str pDiaphgragmType, float angle, int nBlades

Language	Syntax
C++	byte
setShutter(
real shutter )
Python	int
setShutter(
float shutter )

Parameters

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.
dword	nBlades	in	Number of blades (of "POLYGONAL" diaphragm).

Return value

0 = Error setting camera diaphgragm.

1 = Success.

...

getDiaphragm

...

Return value

0 = Error setting shutter.

1 = Success.

Anchor

	getshutter
	getshutter

getShutter

Gets camera shutter.

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

Return value

C++

0 = Error getting shutter.

1 = Success.

Python

Shutter.

Anchor

	setiso
	setiso

setIso

Sets camera ISO.

getDiaphragm( const char** pDiaphragmType, real& angle, dword& nBlades )

Language	Syntax
C++	byte
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.
dword	nBlades	out	Number of blades (if "POLYGONAL" diaphragm).

Return value

C++

0 = Error getting camera diaphragm.

1 = Success.

...

setScreenRegion

Defines a render region for the camera.

Language	Syntax
C++	byte setScreenRegion( dword x1, dword y1, dword x2, dword y2, const char* pRegionType )
Python	int setScreenRegion( int x1, int y1, int x2, int y2, str pRegionType )

Parameters

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

Return value

0 = Error setting screen region.

1 = Success.

...

getScreenRegion

...

setIso( real iso )
Python	int setIso( float iso )

Return value

0 = Error setting ISO.

1 = Success.

Anchor

	getiso
	getiso

getIso

Gets camera ISO.

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

Return value

C++

0 = Error getting ISO.

1 = Success.

Python

ISO.

Anchor

	setfilmsize
	setfilmsize

setFilmSize

Sets camera film size ( 0.001 - 10000.0 meters ). Default = 0.035 x 0.024.

Language	Syntax
C++	byte setFilmSize( real filmWidth, real filmHeight )
Python	int setFilmSize( float filmWidth, float filmHeight)

Return value

0 = Error setting film size.

1 = Success.

Anchor

	getfilmsize
	getfilmsize

getFilmSize

Gets camera film size.

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.

Anchor

	setdiaphragm
	setdiaphragm

setDiaphragm

Sets camera diaphragm.

[ int 'x1', int 'y1', int 'x2', int 'y2', str 'type' ] getScreenRegion(

Language	Syntax
C++	byte getScreenRegion( dword& x1, dword& y1, dword& x2, dword& y2, char* pType setDiaphragm( const char* pDiaphragmType, real angle, dword nBlades )
Python	int setDiaphgragm( str pDiaphgragmType, float angle, int nBlades )

Parameters

dwordx1

Type	Name	In/Out	Description
const char*
pDiaphragmType
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 setting screen region.

...

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.

1 = Success.

Anchor

	getdiaphragm
	getdiaphragm

getDiaphragm

Gets camera diaphragm.

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

Sets camera FPS.

Language	Syntax
C++	byte setFPS( real fps)
Python	int setFPS( float fps )

Return value

0 = Error setting FPS.

1 = Success.

Anchor

	getfps
	getfps

getFPS

Gets camera FPS.

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

Return value

C++

0 = Error getting FPS.

1 = Success.

Python

FPS.

Anchor

	setscreenregion
	setscreenregion

setScreenRegion

Defines a render region for the camera.

Language	Syntax
C++	byte setScreenRegion( dword x1, dword y1, dword x2, dword y2, const char* pRegionType )
Python	int setScreenRegion( int x1, int y1, int x2, int y2, str pRegionType )

Parameters

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

Return value

0 = Error setting screen region.

1 = Success.

Anchor

	getscreenregion
	getscreenregion

getScreenRegion

Gets the render screen region of the camera.

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 setCutPlanes( real zNear, real zFar, bool enabled )
Python	int setCutPlanes( float zNear, float zFar, bool enabled )

Return value

0 = Error setting camera cut planes.

1 = Success.

Anchor

	getcutplanes
	getcutplanes

getCutPlanes

Gets 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

Tuple containing the "cut planes" values.

Anchor

	setshiftlens
	setshiftlens

setShiftLens

Sets camera cut planes.

Language	Syntax
C++	byte setShiftLens( real xShift, real yShift )
Python	int setShiftLens( float xShift, float yShift )

Return value

0 = Error setting camera shift lens.

1 = Success.

Anchor

	getshiftlens
	getshiftlens

getShiftLens

Gets camera shift lens.

Language	Syntax
C++	byte 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

1 = Success

Python

Tuple containing custom bokeh parameters and function success value.

Anchor

	sethide
	sethide

setHide

Sets camera hidden status.

Language	Syntax
C++	byte setHide( bool hide )
Python	int setHide( bool hide )

Return value

0 = Error getting camera shift lens.

1 = Success.

Anchor

	ishide
	ishide

isHide

Gets camera hidden status.

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

setUuid

Sets camera unique ID. For custom purposes.

Language	Syntax
C++	byte setUuid( const char* pUuid )
Python	int setUuid( str uuid )

Return value

0 = Error getting camera shift lens.

1 = Success.

Anchor

	getuuid
	getuuid

getUuid

Gets camera unique ID. For custom purposes.

Language	Syntax
C++	const char* getUuid()
Python	str getUuid()

Return value

String containing the camera unique ID.

Anchor

	setactive
	setactive

setActive

Sets the active camera used when rendering when there is more than one.

Language	Syntax
C++	byte setActive()
Python	int setActive()

Return value

0 = Error setting active.

1 = Success.

Anchor

	free
	free

free

Destroys the camera.

Language	Syntax
C++	byte free()
Python	int free()

Return value

0 = Error destroying the camera.

1 = Success.

Page Comparison

Versions Compared

Old Version 29

New Version Current

Key

Methods

Inherited methods

Parameters

Python

setOrthoValues

getOrthoValues

Return value

C++

Python

getValues

Return value

Return value

C++

Python

setPixelAspect

Return value

getPixelAspect

Return value

C++

Python

setShutter

Parameters

Return value

getDiaphragm

Return value

getShutter

Return value

C++

Python

setIso

Parameters

Return value

C++

setScreenRegion

Parameters

Return value

getScreenRegion

Return value

getIso

Return value

C++

Python

setFilmSize

Return value

getFilmSize

Return value

C++

Python

setDiaphragm

Parameters

Return value

C++

Return value

getDiaphragm

Parameters

Return value

C++

Python

setFPS

Return value

getFPS

Return value

C++

Python

setScreenRegion

Parameters

Return value

getScreenRegion

Parameters

Return value

C++

Python

setCutPlanes

Return value

getCutPlanes