SoFrustumCamera(3)
💅 SoFrustumCamera 💅
okay bestie, welcome to SoFrustumCamera(3) — straight out of the Library Functions Manual, section 3, and she is that girl. this one's long so buckle up, part 1 is right here 🎀
✨ NAME ✨
SoFrustumCamera — the class that defines a camera with a generic frustum..
(yes, two dots. we don't question the ancestors. we respect the ancestors. 🫶)
🌸 SYNOPSIS 🌸
#include <Inventor/nodes/SoFrustumCamera.h>Inherits SoCamera.
🦋 Public Member Functions
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
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 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=0) const
virtual SbBool affectsState (void) const
virtual void GLRenderBelowPath (SoGLRenderAction *action)
virtual void GLRenderInPath (SoGLRenderAction *action)
virtual void GLRenderOffPath (SoGLRenderAction *action)
virtual void getMatrix (SoGetMatrixAction *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)
uint32_t 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=0)
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 *in)
void get (SbString &fielddata, SoOutput *out)
virtual SbBool validateNewFieldValue (SoField *field, void *newval)
virtual void addWriteReference (SoOutput *out, SbBool isfromfield=0)
SbBool getIsBuiltIn (void) 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
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)🧚 Static Public Member Functions inherited from SoCamera
static SoType getClassTypeId (void)
static void initClass (void)🧚 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)
static void initClasses (void)
static uint32_t 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)
static SoType getClassTypeId (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)
static SoType getClassTypeId (void)
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 *in, SoBase *&base, SoType expectedtype)
static void setInstancePrefix (const SbString &c)
static void setTraceRefs (SbBool trace)
static SbBool getTraceRefs (void)
static SbBool connectRoute (SoInput *in, const SbName &fromnodename,
const SbName &fromfieldname, const SbName &tonodename, const SbName
&tofieldname)
static SbBool readRoute (SoInput *in)🌈 Public Attributes
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
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)
~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⭐ 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
}🍓 Protected Types inherited from SoBase
enum BaseFlags { IS_ENGINE = 0x01, IS_GROUP = 0x02 }🍓 Protected Attributes inherited from SoNode
uint32_t uniqueId🍓 Protected Attributes inherited from SoFieldContainer
SbBool isBuiltIn🍓 Static Protected Attributes inherited from SoNode
static uint32_t nextUniqueId = 0
static int nextActionMethodIndex = 0👑 Detailed Description 👑
The SoFrustumCamera class defines a camera with a generic frustum..
okay so here's the tea ☕ — the SoFrustumCamera class lets you specify a frustum in exactly the same manner as the OpenGL glFrustum() function. iconic behavior, no cap. she brings four new fields to the party — left, right, top, bottom — and for the two last glFrustum() parameters she just uses SoCamera::nearDistance and SoCamera::farDistance. reusing what's already there? that's efficiency, that's main character energy 💅
this camera is lowkey a lifesaver in applications that need full control over the view frustum, like CAVE setups or other multipipe applications. if you're doing the big immersive multi-screen thing, she's your girl 🫶
✨ Since: Coin 2.5
and that's the end of part 1, bestie — the rest is coming right up, don't go anywhere 💖
💖 Constructor & Destructor Documentation 💖
SoFrustumCamera::SoFrustumCamera (void )
Okay so bestie, this is the constructor. It does the constructor thing. It references bottom, left, right, SoFrustumCamera(), and top. And it's referenced by getFieldData(), and SoFrustumCamera().
SoFrustumCamera::~SoFrustumCamera (void ) [protected], [virtual]
This is the destructor. Destructor. It destructs. That's the whole vibe.
✨ Member Function Documentation ✨
SoType SoFrustumCamera::getTypeId (void ) const [virtual]
Returns the type identification of an object derived from a class inheriting from SoBase. This is used for run-time type checking and "downward" casting.
Usage example:
void foo(SoNode * node)
{
if (node->getTypeId() == SoFile::getClassTypeId()) {
SoFile * filenode = (SoFile *)node; // safe downward cast, knows the type
}
else if (node->getTypeId().isOfType(SoGroup::getClassTypeId())) {
SoGroup * group = (SoGroup *)node; // safe downward cast, knows the type
}
}For application programmers wanting to extend the library with new nodes, engines, nodekits, draggers or others: this method needs to be overridden in all subclasses. This is typically done as part of setting up the full type system for extension classes, which is usually accomplished by using the pre-defined macros available through for instance Inventor/nodes/SoSubNode.h (SO_NODE_INIT_CLASS and SO_NODE_CONSTRUCTOR for node classes), Inventor/engines/SoSubEngine.h (for engine classes) and so on.
For more information on writing Coin extensions, see the class documentation of the toplevel superclasses for the various class groups.
Reimplemented from SoCamera.
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.
References SoFrustumCamera().
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. See documentation in subclasses.
Implements SoCamera.
References bottom, and top.
SbViewVolume SoFrustumCamera::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 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 SoCamera::getView() to see how this is done.
Implements SoCamera.
References bottom, SbViewVolume::frustum(), left, SoCamera::orientation, SoCamera::position, right, SbViewVolume::rotateCamera(), top, and SbViewVolume::translateCamera().
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. 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.
References bottom, SbSphere::circumscribe(), SbVec3f::dot(), SoCamera::farDistance, SoCamera::focalDistance, SbBox3f::getCenter(), SbSphere::getRadius(), SbBox3f::isEmpty(), SoCamera::nearDistance, SbVec3f::normalize(), SoCamera::orientation, SoCamera::position, SoDebugError::postWarning(), and top.
🎀 Member Data Documentation 🎀
SoSFFloat SoFrustumCamera::left
The left clipping plane position. Default value is -0.5.
Referenced by getViewVolume(), and SoFrustumCamera().
SoSFFloat SoFrustumCamera::right
The right clipping plane position. Default value is 0.5
Referenced by getViewVolume(), and SoFrustumCamera().
SoSFFloat SoFrustumCamera::top
The top clipping plane position. Default value is 0.5.
Referenced by getViewVolume(), scaleHeight(), SoFrustumCamera(), and viewBoundingBox().
SoSFFloat SoFrustumCamera::bottom
The bottom clipping plane position. Default value is -0.5.
Referenced by getViewVolume(), scaleHeight(), SoFrustumCamera(), and viewBoundingBox().
🌸 Author 🌸
Generated automatically by Doxygen for Coin from the source code.
Coin, version 2.5.0, and this page is SoFrustumCamera(3) — that's the footer, bestie. 💖✨
📦 where this page comes from
- fedora 43: Coin2-devel 2.5.0-52.fc43 · GPL-2.0-only
- fedora 43: Coin2-devel 2.5.0-52.fc43 · GPL-2.0-only
- fedora 44: Coin2-devel 2.5.0-54.fc44 · GPL-2.0-only
- fedora 44: Coin2-devel 2.5.0-54.fc44 · GPL-2.0-only
- 💖 girlified by deepseek-ai/DeepSeek-V4.1-Flash on : a language model's rewrite of the original, under its terms