--- name: "SoOrthographicCamera" section: "3" platform: "linux" package: "coin" version: "1:4.0.10-1" release: "Arch Linux 2026-11-01" platforms: ["linux"] url: "https://new.carta.tech/SoOrthographicCamera" --- # SoOrthographicCamera(3) The SoOrthographicCamera class defines a camera node with orthographic rendering. ## NAME SoOrthographicCamera - The **SoOrthographicCamera** class defines a camera node with orthographic rendering. ## SYNOPSIS \#include \ Inherits **SoCamera**. ### Public Member Functions virtual **SoType** **getTypeId** (void) const\ **SoOrthographicCamera** (void)\ virtual void **scaleHeight** (float scalefactor)\ virtual **SbViewVolume** **getViewVolume** (float useaspectratio=0.0f) const\ virtual void **viewBoundingBox** (const **SbBox3f** &box, float aspect, float slack)\ Public Member Functions inherited from **SoCamera** **SbViewVolume** **getViewVolume** (const **SbViewportRegion** &vp, **SbViewportRegion** &resultvp, const **SbMatrix** &mm=**SbMatrix::identity**()) const\ void **pointAt** (const **SbVec3f** &targetpoint)\ void **pointAt** (const **SbVec3f** &targetpoint, const **SbVec3f** &upvector)\ void **viewAll** (**SoNode** \*const sceneroot, const **SbViewportRegion** &vpregion, const float slack=1.0f)\ void **viewAll** (**SoPath** \*const path, const **SbViewportRegion** &vpregion, const float slack=1.0f)\ **SbViewportRegion** **getViewportBounds** (const **SbViewportRegion** ®ion) const\ void **setStereoMode** (**StereoMode** mode)\ **StereoMode** **getStereoMode** (void) const\ void **setStereoAdjustment** (float adjustment)\ float **getStereoAdjustment** (void) const\ void **setBalanceAdjustment** (float adjustment)\ float **getBalanceAdjustment** (void) const\ virtual void **doAction** (**SoAction** \*action)\ virtual void **callback** (**SoCallbackAction** \*action)\ virtual void **GLRender** (**SoGLRenderAction** \*action)\ virtual void **audioRender** (**SoAudioRenderAction** \*action)\ virtual void **getBoundingBox** (**SoGetBoundingBoxAction** \*action)\ virtual void **getMatrix** (**SoGetMatrixAction** \*action)\ virtual void **handleEvent** (**SoHandleEventAction** \*action)\ virtual void **rayPick** (**SoRayPickAction** \*action)\ virtual void **getPrimitiveCount** (**SoGetPrimitiveCountAction** \*action)\ Public Member Functions inherited from **SoNode** void **setOverride** (const SbBool state)\ SbBool **isOverride** (void) const\ void **setNodeType** (const **NodeType** type)\ **NodeType** **getNodeType** (void) const\ virtual **SoNode** \* **copy** (SbBool copyconnections=FALSE) const\ virtual SbBool **affectsState** (void) const\ virtual void **GLRenderBelowPath** (**SoGLRenderAction** \*action)\ virtual void **GLRenderInPath** (**SoGLRenderAction** \*action)\ virtual void **GLRenderOffPath** (**SoGLRenderAction** \*action)\ virtual void **pick** (**SoPickAction** \*action)\ virtual void **search** (**SoSearchAction** \*action)\ virtual void **write** (**SoWriteAction** \*action)\ virtual void **grabEventsSetup** (void)\ virtual void **grabEventsCleanup** (void)\ virtual void **startNotify** (void)\ virtual void **notify** (**SoNotList** \*l)\ SbUniqueId **getNodeId** (void) const\ virtual **SoChildList** \* **getChildren** (void) const\ virtual void **writeInstance** (**SoOutput** \*out)\ virtual **SoNode** \* **addToCopyDict** (void) const\ virtual void **copyContents** (const **SoFieldContainer** \*from, SbBool copyconnections)\ virtual **SoFieldContainer** \* **copyThroughConnection** (void) const\ Public Member Functions inherited from **SoFieldContainer** void **setToDefaults** (void)\ SbBool **hasDefaultValues** (void) const\ SbBool **fieldsAreEqual** (const **SoFieldContainer** \*container) const\ void **copyFieldValues** (const **SoFieldContainer** \*container, SbBool copyconnections=FALSE)\ SbBool **set** (const char \*const fielddata)\ void **get** (**SbString** &fielddata)\ virtual int **getFields** (**SoFieldList** &l) const\ virtual int **getAllFields** (**SoFieldList** &l) const\ virtual **SoField** \* **getField** (const **SbName** &name) const\ virtual **SoField** \* **getEventIn** (const **SbName** &name) const\ virtual **SoField** \* **getEventOut** (const **SbName** &name) const\ SbBool **getFieldName** (const **SoField** \*const field, **SbName** &name) const\ SbBool **enableNotify** (const SbBool flag)\ SbBool **isNotifyEnabled** (void) const\ SbBool **set** (const char \*fielddata, **SoInput** \*input)\ void **get** (**SbString** &fielddata, **SoOutput** \*out)\ virtual SbBool **validateNewFieldValue** (**SoField** \*field, void \*newval)\ virtual void **addWriteReference** (**SoOutput** \*out, SbBool isfromfield=FALSE)\ SbBool **getIsBuiltIn** (void) const\ virtual void **getFieldsMemorySize** (size\_t &managed, size\_t &unmanaged) const\ void **setUserData** (void \*userdata) const\ void \* **getUserData** (void) const\ Public Member Functions inherited from **SoBase** void **ref** (void) const\ void **unref** (void) const\ void **unrefNoDelete** (void) const\ int32\_t **getRefCount** (void) const\ void **touch** (void)\ SbBool **isOfType** (**SoType** type) const\ Returns TRUE if the type of this object is either of the same type or inherited from *type*. virtual **SbName** **getName** (void) const\ virtual void **setName** (const **SbName** &newname)\ void **addAuditor** (void \*const auditor, const **SoNotRec::Type** type)\ void **removeAuditor** (void \*const auditor, const **SoNotRec::Type** type)\ const **SoAuditorList** & **getAuditors** (void) const\ SbBool **shouldWrite** (void)\ void **assertAlive** (void) const\ ### Static Public Member Functions static **SoType** **getClassTypeId** (void)\ static void **initClass** (void)\ Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system. Static Public Member Functions inherited from **SoCamera** static **SoType** **getClassTypeId** (void)\ static void **initClass** (void)\ Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system. Static Public Member Functions inherited from **SoNode** static uint32\_t **getCompatibilityTypes** (const **SoType** &nodetype)\ static **SoType** **getClassTypeId** (void)\ static **SoNode** \* **getByName** (const **SbName** &name)\ static int **getByName** (const **SbName** &name, **SoNodeList** &l)\ static void **initClass** (void)\ Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system. static void **initClasses** (void)\ static SbUniqueId **getNextNodeId** (void)\ static int **getActionMethodIndex** (const **SoType** type)\ static void **getBoundingBoxS** (**SoAction** \*action, **SoNode** \*node)\ static void **GLRenderS** (**SoAction** \*action, **SoNode** \*node)\ static void **callbackS** (**SoAction** \*action, **SoNode** \*node)\ static void **getMatrixS** (**SoAction** \*action, **SoNode** \*node)\ static void **handleEventS** (**SoAction** \*action, **SoNode** \*node)\ static void **pickS** (**SoAction** \*action, **SoNode** \*node)\ static void **rayPickS** (**SoAction** \*action, **SoNode** \*node)\ static void **searchS** (**SoAction** \*action, **SoNode** \*node)\ static void **writeS** (**SoAction** \*action, **SoNode** \*node)\ static void **audioRenderS** (**SoAction** \*action, **SoNode** \*node)\ static void **getPrimitiveCountS** (**SoAction** \*action, **SoNode** \*node)\ Static Public Member Functions inherited from **SoFieldContainer** static void **initClass** (void)\ Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system. static **SoType** **getClassTypeId** (void)\ This static method returns the **SoType** object associated with objects of this class. static void **cleanupClass** (void)\ static void **initCopyDict** (void)\ static void **addCopy** (const **SoFieldContainer** \*orig, const **SoFieldContainer** \*copy)\ static **SoFieldContainer** \* **checkCopy** (const **SoFieldContainer** \*orig)\ static **SoFieldContainer** \* **findCopy** (const **SoFieldContainer** \*orig, const SbBool copyconnections)\ static void **copyDone** (void)\ Static Public Member Functions inherited from **SoBase** static void **initClass** (void)\ Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system. static **SoType** **getClassTypeId** (void)\ This static method returns the **SoType** object associated with objects of this class. static void **addName** (**SoBase** \*const base, const char \*const name)\ static void **removeName** (**SoBase** \*const base, const char \*const name)\ static void **incrementCurrentWriteCounter** (void)\ static void **decrementCurrentWriteCounter** (void)\ static **SoBase** \* **getNamedBase** (const **SbName** &name, **SoType** type)\ static int **getNamedBases** (const **SbName** &name, **SoBaseList** &baselist, **SoType** type)\ static SbBool **read** (**SoInput** \*input, **SoBase** \*&base, **SoType** expectedtype)\ static void **setInstancePrefix** (const **SbString** &c)\ static void **setTraceRefs** (SbBool trace)\ static SbBool **getTraceRefs** (void)\ static SbBool **connectRoute** (**SoInput** \*input, const **SbName** &fromnodename, const **SbName** &fromfieldname, const **SbName** &tonodename, const **SbName** &tofieldname)\ static SbBool **readRoute** (**SoInput** \*input)\ ### Public Attributes **SoSFFloat** **height**\ Public Attributes inherited from **SoCamera** **SoSFEnum** **viewportMapping**\ **SoSFVec3f** **position**\ **SoSFRotation** **orientation**\ **SoSFFloat** **aspectRatio**\ **SoSFFloat** **nearDistance**\ **SoSFFloat** **farDistance**\ **SoSFFloat** **focalDistance**\ ### Protected Member Functions virtual const **SoFieldData** \* **getFieldData** (void) const\ virtual **~SoOrthographicCamera** ()\ Protected Member Functions inherited from **SoCamera** **SoCamera** (void)\ virtual **~SoCamera** ()\ virtual void **jitter** (int numpasses, int curpass, const **SbViewportRegion** &vpreg, **SbVec3f** &jitteramount) const\ Protected Member Functions inherited from **SoNode** **SoNode** (void)\ virtual **~SoNode** ()\ virtual SbBool **readInstance** (**SoInput** \*in, unsigned short flags)\ Protected Member Functions inherited from **SoFieldContainer** **SoFieldContainer** (void)\ virtual **~SoFieldContainer** ()\ Protected Member Functions inherited from **SoBase** **SoBase** (void)\ virtual **~SoBase** ()\ virtual void **destroy** (void)\ SbBool **hasMultipleWriteRefs** (void) const\ SbBool **writeHeader** (**SoOutput** \*out, SbBool isgroup, SbBool isengine) const\ void **writeFooter** (**SoOutput** \*out) const\ virtual const char \* **getFileFormatName** (void) const\ virtual **SoNotRec** **createNotRec** (void)\ ### Static Protected Member Functions static const **SoFieldData** \*\* **getFieldDataPtr** (void)\ Static Protected Member Functions inherited from **SoCamera** static const **SoFieldData** \*\* **getFieldDataPtr** (void)\ Static Protected Member Functions inherited from **SoNode** static const **SoFieldData** \*\* **getFieldDataPtr** (void)\ static void **setNextActionMethodIndex** (int index)\ static int **getNextActionMethodIndex** (void)\ static void **incNextActionMethodIndex** (void)\ static void **setCompatibilityTypes** (const **SoType** &nodetype, const uint32\_t bitmask)\ Static Protected Member Functions inherited from **SoBase** static uint32\_t **getCurrentWriteCounter** (void)\ static void **staticDataLock** (void)\ static void **staticDataUnlock** (void)\ ### Additional Inherited Members Public Types inherited from **SoCamera** enum **ViewportMapping** { **CROP\_VIEWPORT\_FILL\_FRAME**, **CROP\_VIEWPORT\_LINE\_FRAME**, **CROP\_VIEWPORT\_NO\_FRAME**, **ADJUST\_CAMERA**, **LEAVE\_ALONE** }\ enum **StereoMode** { **MONOSCOPIC**, **LEFT\_VIEW**, **RIGHT\_VIEW** }\ Public Types inherited from **SoNode** enum **NodeType** { **INVENTOR** = 0x0000, **VRML1** = 0x0001, **VRML2** = 0x0002, **INVENTOR\_1** = 0x0004, **INVENTOR\_2\_0** = 0x0008, **INVENTOR\_2\_1** = 0x0010, **INVENTOR\_2\_5** = 0x0020, **INVENTOR\_2\_6** = 0x0040, **COIN\_1\_0** = 0x0080, **COIN\_2\_0** = 0x0100, **EXTENSION** = 0x0200, **COIN\_2\_2** = 0x0400, **COIN\_2\_3** = 0x0800, **COIN\_2\_4** = 0x1000, **INVENTOR\_5\_0** = 0x2000, **COIN\_2\_5** = 0x4000, **COIN\_3\_0** = 0x8000, **INVENTOR\_6\_0** = 0x10000, **COIN\_4\_0** = 0x20000 }\ Protected Types inherited from **SoBase** enum **BaseFlags** { **IS\_ENGINE** = 0x01, **IS\_GROUP** = 0x02 }\ Protected Attributes inherited from **SoNode** SbUniqueId **uniqueId**\ Protected Attributes inherited from **SoFieldContainer** SbBool **isBuiltIn**\ Static Protected Attributes inherited from **SoNode** static SbUniqueId **nextUniqueId** = 1\ static int **nextActionMethodIndex** = 0\ ## Detailed Description The **SoOrthographicCamera** class defines a camera node with orthographic rendering. Orthographic rendering will not give a particularly realistic impression of the scene, but non-realistic rendering is for various reasons widely used in applications for e.g. Computer Aided Design. Also, a simple technique for drawing overlay / HUD style graphics (often appearing to be in 2D) can be implemented by setting up a "sub scene graph" with an **SoOrthographicCamera** and the geometry. As a simple demonstration of this concept, load this file into e.g. the ExaminerViewer: ``` #Inventor V2.1 ascii Separator { PerspectiveCamera { position 0 0 5 } Cone { } Separator { OrthographicCamera { position -0.75 -0.75 2 } BaseColor { rgb 1 1 0 } Sphere { radius 0.2 } } } ``` You will likely encounter z-buffer issues with this technique which makes the overlay / HUD graphics end up interspersed with the "real" geometry. If so, this can be solved by e.g. inserting an **SoCallback** node in the sub-scene, where you let the callback disable the depth buffer with glDisable(GL\_DEPTH\_TEST). **FILE FORMAT/DEFAULTS:** ``` OrthographicCamera { viewportMapping ADJUST_CAMERA position 0 0 1 orientation 0 0 1 0 nearDistance 1 farDistance 10 aspectRatio 1 focalDistance 5 height 2 } ``` ## Constructor & Destructor Documentation ### SoOrthographicCamera::SoOrthographicCamera (void ) Constructor. ### SoOrthographicCamera::~SoOrthographicCamera () \[protected\], \[virtual\] Destructor. ## Member Function Documentation ### SoType SoOrthographicCamera::getClassTypeId (void ) \[static\] This static method returns the **SoType** object associated with objects of this class. ### SoType SoOrthographicCamera::getTypeId (void ) const \[virtual\] Returns the type identification of an object derived from a class inheriting **SoBase**. This is used for runtime type checking and "downward" casting. Reimplemented from **SoCamera**. ### const SoFieldData \*\* SoOrthographicCamera::getFieldDataPtr (void ) \[static\], \[protected\] *This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.*\ Returns the **SoFieldData** class which holds information about fields in this node. ### const SoFieldData \* SoOrthographicCamera::getFieldData (void ) const \[protected\], \[virtual\] Returns a pointer to the class-wide field data storage object for this instance. If no fields are present, returns NULL. Reimplemented from **SoCamera**. ### void SoOrthographicCamera::scaleHeight (float scalefactor) \[virtual\] Scale **SoOrthographicCamera::height** by multiplying with *scalefactor*. Implements **SoCamera**. ### SbViewVolume SoOrthographicCamera::getViewVolume (float useaspectratio = 0.0f) const \[virtual\] Returns total view volume covered by the camera under the current settings. This view volume is not adjusted to account for viewport mapping. If you want the same view volume as the one used during rendering, you should use getViewVolume(SbViewportRegion & vp, const SbMatrix & mm), or do something like this: ``` SbViewVolume vv; float aspectratio = myviewport.getViewportAspectRatio(); switch (camera->viewportMapping.getValue()) { case SoCamera::CROP_VIEWPORT_FILL_FRAME: case SoCamera::CROP_VIEWPORT_LINE_FRAME: case SoCamera::CROP_VIEWPORT_NO_FRAME: vv = camera->getViewVolume(0.0f); break; case SoCamera::ADJUST_CAMERA: vv = camera->getViewVolume(aspectratio); if (aspectratio < 1.0f) vv.scale(1.0f / aspectratio); break; case SoCamera::LEAVE_ALONE: vv = camera->getViewVolume(0.0f); break; default: assert(0 && "unknown viewport mapping"); break; } ``` Also, for the CROPPED viewport mappings, the viewport might be changed if the viewport aspect ratio is not equal to the camera aspect ratio. See the SoCamera::getView() source-code (private method) to see how this is done. Implements **SoCamera**. ### void SoOrthographicCamera::viewBoundingBox (const SbBox3f & box, float aspect, float slack) \[virtual\] Convenience method for setting up the camera definition to cover the given bounding *box* with the given *aspect* ratio. Multiplies the exact dimensions with a *slack* factor to have some space between the rendered model and the borders of the rendering area. If you define your own camera node class, be aware that this method should *not* set the orientation field of the camera, only the position, focal distance and near and far clipping planes. Implements **SoCamera**. ## Member Data Documentation ### SoSFFloat SoOrthographicCamera::height Height of viewport in world space scale. Defaults to 2.0 units. ## Author Generated automatically by Doxygen for Coin from the source code.