Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3

...

Citerator

Methods

NameDescription
setStepSets the camera parameters that can change in an animation.
getStepGets the camera parameteres that can change in an animation.
setOrthoValuesSets orthographic camera values.
getOrthoValuesGets orthographic camera values.
getValuesGets the camera parameters that cannot change in an animation.
setNameSets camera name.
getNameGets camera name.
setResolutionSets camera resolution.
getResolutionGets camera resolution.
setPixelAspectSets camera pixel aspect.
getPixelAspectGets camera pixel aspect.
setShutterSets camera shutter.
getShutterGets camera shutter.
setIsoSets camera ISO.
getIsoGets camera ISO.
setFilmSizeSets camera film size.
getFilmSizeGets camera film size.
setDiaphragmSets camera diaphragm.
getDiaphragmGets camera diaphragm.
setFPSSets camera FPS.
getFPSGets camera FPS.
setScreenRegionDefines a render region for the camera.
getScreenRegionGets render region defined.
setCutPlanesSets camera cut planes.
getCutPlanesGets camera cut planes.
setShiftLensSets camera shift lens.
getShiftLensGets camera shift lens.
setCustomBokehDefines a custom bokeh.
getCustomBokehGets custom bokeh parameters.
setHideSets camera hidden status.
isHideGets camera hidden status.
setUuidSets camera unique ID. For custom purposes.
getUuidGets camera unique ID. For custom purposes.
setUserDataInternal use.
getUserDataInternal use.
setActiveSets the active camera in case the scene have more than one.
setDirtyInternal use.
isDirtyInternal use.
Ccamera#freefreeDestroys the camera.

Inherited methods

...

Tuple containing "xShift" and "yShift".

Anchor
sethidesetcustombokehsethide
setcustombokeh

setHide

...

setCustomBokeh

Defines a custom bokeh.

setHide( bool hide setHide( bool hide
LanguageSyntax
C++byte
setCustomBokeh( const real& ratio, const real& angle, bool enabled )
Pythonint
setCustomBokeh( float ratio, float angle, bool enabled )

Return

...

Value

0 = Error getting camera shift lens.

1 = Success

Anchor
getcustombokeh
getcustombokeh

getCustomBokeh

Gets custom bokeh parameters.

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

LanguageSyntax
C++byte setHide( bool hide )
Pythonint setHide( bool hide )

Return value

0 = Error getting camera shift lens.

1 = Success.

Anchor
ishide
ishide

isHide

Gets camera hidden status.

LanguageSyntax
C++byte isHide( bool& hide )
Pythonbool 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.