Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

NameDescription
setStepSets the camera parameters that can change in an animation.
getStepGets the camera parameteres that can change in an animation.
setOrthoValues TODO
getOrthoValues TODO
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.
setHideSets camera hidden status.
isHideGets camera hidden status.
setUuidSets camera unique ID. For custom purposes.
getUuidGets camera unique ID. For custom purposes.
setUserData 
getUserData 
setActiveSets the active camera in case the scene have more than one.
setDirty 
isDirty 
freeDestroys the camera.

...

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

Anchor
setpixelaspect
setpixelaspect

setPixelAspect

Sets camera pixel aspect.

LanguageSyntax
C++byte setPixelAspect( real pixelAspect )
Pythonint setPixelAspect( float pixelAspext )

Return value

0 = Error setting pixel aspect.

1 = Success.

Anchor
getpixelaspect
getpixelaspect

getPixelAspect

Gets camera pixel aspect.

LanguageSyntax
C++byte getPixelAspect( real& pixelAspect)
Pythonfloat getPixelAspect()

Return value

C++

0 = Error getting pixel aspect.

1 = Success.

Python

Pixel aspect.

Anchor
setfilmsize
setfilmsize

setFilmSize

...

LanguageSyntax
C++byte setFilmSize( real filmWidth, real filmHeight )
Pythonint setFilmSize( float filmWidth, float filmHeight)

Return value

0 = Error setting film size.

...

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

...

TypeNameIn/OutDescription
const char*pDiaphragmTypeinDiaphgragm type. Must be one of the following values: "CIRCULAR" or "POLYGONAL".
realangleinDiaphgragm angle.
dwordnBladesinNumber of blades (of "POLYGONAL" diaphragm).

Return value

0 = Error setting camera diaphgragm.

...

TypeNameIn/OutDescription
const char*pDiaphragmTypeoutDiaphgragm type. Can be one of the following values: "CIRCULAR" or "POLYGONAL".
realangleoutDiaphgragm angle.
dwordnBladesoutNumber of blades (if "POLYGONAL" diaphragm).

Return value

C++

0 = Error getting camera diaphragm.

...

TypeNameIn/OutDescription
dwordx1inX-axis up-left edge of the region (in pixels)
dwordy1inY-axis up-left edge of the region (in pixels)
dwordx2inX-axis down-right edge of the region (in pixels)
dwordy2inY-axis down-right edge of the region (in pixels)
const char*pRegionTypeinRegion type. Must be one of the following values: "REGION" or "BLOW UP".

Return value

0 = Error setting screen region.

...

TypeNameIn/OutDescription
dwordx1outX-axis up-left edge of the region (in pixels)
dwordy1outY-axis up-left edge of the region (in pixels)
dwordx2outX-axis down-right edge of the region (in pixels)
dwordy2outY-axis down-right edge of the region (in pixels)
const char*pRegionTypeoutRegion type. Must be one of the following values: "REGION" or "BLOW UP".

Return value

C++

0 = Error setting screen region.

1 = Success.

...