SoFrustumCamera(3)

📦
version 4.0.10 · 4 versions
, in fedora 43, fedora 44

💖 SoFrustumCamera(3) — Coin 💖

okay bestie, welcome to the manual page for SoFrustumCamera(3) from Coin ✨. This is part 1, and it's giving "camera class with a generic frustum" energy. Let's get into it, no cap. 🫶

🌸 NAME 🌸

SoFrustumCamera — the SoFrustumCamera class defines a camera with a generic frustum.. 💅

🦋 SYNOPSIS 🦋

#include <Inventor/nodes/SoFrustumCamera.h>

Inherits SoCamera. periodt.

✨ Public Member Functions ✨

okay so these are the ones that belong to SoFrustumCamera itself, bestie. main character functions only. 💖

  • virtual SoType getTypeId (void) const
  • SoFrustumCamera (void)
  • virtual void scaleHeight (float scalefactor)
  • virtual SbViewVolume getViewVolume (float useaspectratio=0.0f) const

💖 Public Member Functions inherited from SoCamera 💖

these are the ones you get from your SoCamera ancestor, lowkey iconic. 🎀

  • 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 &region) 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 🦋

these come from SoNode, the blueprint era. 🌈

  • 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 🎀

SoFieldContainer said "here, have some field-management realness." 💅

  • 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 💜

the SoBase foundation, the OG great-grandparent. not me being emotional about inheritance. 😭

  • 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 — gives you TRUE when the type of this object is either the same type as type or inherited from type. iykyk.
  • 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 🌟

these are the static besties, no instance required. slay. ✨

  • static SoType getClassTypeId (void)
  • static void initClass (void) — does the setup thing for data shared by every instance of this class, like feeding the necessary info to the Coin type system.

🌸 Static Public Member Functions inherited from SoCamera 🌸

  • static SoType getClassTypeId (void)
  • static void initClass (void) — does the setup thing for data shared by every instance of this class, like feeding the necessary info 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) — does the setup thing for data shared by every instance of this class, like feeding the necessary info 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) — does the setup thing for data shared by every instance of this class, like feeding the necessary info 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) — does the setup thing for data shared by every instance of this class, like feeding the necessary info 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 🫶

the public data members, living out loud. no shame. 💅

  • SoSFFloat left
  • SoSFFloat right
  • SoSFFloat top
  • SoSFFloat bottom

💖 Public Attributes inherited from SoCamera 💖

  • SoSFEnum viewportMapping
  • SoSFVec3f position
  • SoSFRotation orientation
  • SoSFFloat aspectRatio
  • SoSFFloat nearDistance
  • SoSFFloat farDistance
  • SoSFFloat focalDistance

🛡️ Protected Member Functions 🛡️

protected, so bestie you can't just call these from outside. respect the boundary. 🫶

  • virtual const SoFieldData * getFieldData (void) const
  • virtual ~SoFrustumCamera ()
  • virtual void viewBoundingBox (const SbBox3f &box, float aspect, float slack)

🦋 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 and protected? it's giving mysterious and powerful. 👑

  • 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 🌈

these are the inherited types, the enum era. so iconic. ✨

🎀 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 🎀

bestie, SoNode hands down a whole enum to its children, and it's giving "every era of Inventor and Coin, accounted for". Here's the full list, hex values and all, no cap:

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 🧚

and SoBase bequeaths this lil duo:

enum BaseFlags { IS_ENGINE = 0x01, IS_GROUP = 0x02 }

💜 Protected Attributes inherited from SoNode 💜

  • SbUniqueId uniqueId — yeah, that's the vibe, each node keeps its own unique id.

🦋 Protected Attributes inherited from SoFieldContainer 🦋

  • SbBool isBuiltIn — the "am I built in or not" flag, iconic.

⭐ Static Protected Attributes inherited from SoNode ⭐

  • static SbUniqueId nextUniqueId = 1 — the counter that just keeps going, main character energy fr.
  • static int nextActionMethodIndex = 0 — same deal but for action method indexes, periodt.

💅 Detailed Description 💅

okay so, the tea: the SoFrustumCamera class defines a camera with a generic frustum. literally that's its whole thing.

What it does is let you specify a frustum the exact same way the OpenGL glFrustum() function does. It brings four new fields to the party — left, right, top, bottom — and then it reuses SoCamera::nearDistance and SoCamera::farDistance for those last two glFrustum() parameters. so the two near/far ones come from the parent, and the four planar ones are all its own. slay.

Where is this actually useful tho? applications that need full control over the view frustum — think CAVE setups or other multipipe applications. if you're doing multi-screen immersive stuff, this is your girl. 🫶

Since: Coin 2.5 — she's been around, lowkey a legend.

✨ Constructor & Destructor Documentation ✨

SoFrustumCamera::SoFrustumCamera (void )

Constructor. the birth. the origin story. 🎀

SoFrustumCamera::~SoFrustumCamera (void ) [protected], [virtual]

Destructor. protected and virtual, so she goes out with grace. 😭

🌸 Member Function Documentation 🌸

SoType SoFrustumCamera::getClassTypeId (void ) [static]

This static method returns the SoType object associated with objects of this class. it's the "who am I in the type system" lookup, bestie.

SoType SoFrustumCamera::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. so when you need to know what you're holding at runtime before you cast down, this is the move. 💅

Reimplemented from SoCamera.

const SoFieldData ** SoFrustumCamera::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. iykyk — if you're not poking at Coin's internals, you can scroll past this one.

Returns the SoFieldData class which holds information about fields in this node.

const SoFieldData * SoFrustumCamera::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 SoFrustumCamera::scaleHeight (float scalefactor) [virtual]

Sets a scalefactor for the height of the camera viewport. What "viewport height" means exactly in this context depends on the camera model — so don't come for me, go read the documentation in the subclasses for the deets. 👑

Implements SoCamera.

SbViewVolume SoFrustumCamera::getViewVolume (float useaspectratio = 0.0f) const [virtual]

Returns the total view volume covered by the camera under the current settings. this is the whole "what can you actually see rn" answer. 🌈

⚠️ heads up bestie: this view volume is not adjusted to account for viewport mapping. so 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 SoFrustumCamera::viewBoundingBox (const SbBox3f & box, float aspect, float slack) [protected], [virtual]

Convenience method for setting up the camera definition to cover the given bounding box with the given aspect ratio. It multiplies the exact dimensions with a slack factor so you get some breathing room between the rendered model and the borders of the rendering area. giving the model personal space, we love to see it. 🍓

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. write that down. ✍️

Implements SoCamera.

👑 Member Data Documentation 👑

SoSFFloat SoFrustumCamera::left

The left clipping plane position. Default value is -0.5.

SoSFFloat SoFrustumCamera::right

The right clipping plane position. Default value is 0.5

SoSFFloat SoFrustumCamera::top

The top clipping plane position. Default value is 0.5.

SoSFFloat SoFrustumCamera::bottom

The bottom clipping plane position. Default value is -0.5.

four fields, four numbers, perfectly balanced as all things should be. 💖

🦋 Author 🦋

Generated automatically by Doxygen for Coin from the source code. so technically the author is a robot, but the robot ate. 💀✨

and that's a wrap, bestie!! this was Version 4.0.10, dated Thu Jun 25 2026 00:00:00, and it's the SoFrustumCamera(3) page — go forth and frustum with full control. no cap, you got this. 🎀💜🫶

📦 where this page comes from