...
| 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 | ||||
|---|---|---|---|---|
|
...
| 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
...
| 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 | ||||
|---|---|---|---|---|
|
...
| Language | Syntax |
|---|---|
| C++ | byte getShutter( real& shutter ) |
| Python | float getShutter() |
Return value
C++
0 = Error getting shutter.
1 = Success.
Python
Shutter.
| Anchor | ||||
|---|---|---|---|---|
|
...
| Language | Syntax |
|---|---|
| C++ | byte getIso( real& iso ) |
| Python | float getIso() |
Return value
C++
0 = Error getting ISO.
1 = Success.
Python
ISO.
| Anchor | ||||
|---|---|---|---|---|
|
...
| 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.
...
| 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. |
| dword | nBlades | out | Number of blades (if "POLYGONAL" diaphragm). |
Return value
C++
0 = Error getting camera diaphragm.
1 = Success.
Python
Tuple containing the requested diaphragm parameters.
| Anchor | ||||
|---|---|---|---|---|
|
setFPS
Sets camera FPS.
...
| Language | Syntax |
|---|---|
| C++ | byte getFPS( real& fps ) |
| Python | float getFPS() |
Return value
C++
0 = Error getting FPS.
1 = Success.
Python
FPS.
| Anchor | ||||
|---|---|---|---|---|
|
...
| 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 | ||||
|---|---|---|---|---|
|
...
| 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 | ||||
|---|---|---|---|---|
|
...
| 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
Dictionary Tuple containing "xShift" and "yShift".
...
| 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.