...
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#freefree | Destroys the camera. |
Inherited methods
...
| 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.
...
| 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.
...
Tuple containing "xShift" and "yShift".
| Anchor | ||||
|---|---|---|---|---|
|
setHide
...
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
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
Sets camera hidden status.
| Language | Syntax |
|---|---|
| C++ | byte setHide( bool hide ) |
| Python | int setHide( bool hide ) |
Return value
0 = Error getting camera shift lens.
...
| 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 | ||||
|---|---|---|---|---|
|
...
0 = Error destroying the camera.
1 = Success.