SoCameraKit(3)

📦 version 3.1.3, in fedora 43, fedora 44

💖 SoCameraKit(3) — Library Functions Manual 💖

okay so bestie, welcome to the SoCameraKit page 💅 this is part 1 of 2, we're doing the whole thing, no skipping, and yes it's long, but so is my attention span when the topic slays.

✨ NAME ✨

SoCameraKit — the SoCameraKit class is a node kit with a transform and a camera. that's it. that's the whole vibe. a transform, a camera, together, in a kit. iconic behaviour honestly 🎀

✨ SYNOPSIS ✨

first things first, you gotta pull the header in:

#include <Inventor/nodekits/SoCameraKit.h>

and it Inherits SoBaseKit. so everything SoBaseKit can do, it can do too (and we're gonna list literally all of it, don't you worry).

💫 Public Member Functions 💫

these three are the ones that are actually SoCameraKit's own, the rest below are inherited:

  • virtual SoType getTypeId (void) const — hands you the type id, the const version, no drama ✨
  • virtual const SoNodekitCatalog * getNodekitCatalog (void) const — gives you back the nodekit catalog pointer, also const 🎀
  • SoCameraKit (void) — the constructor. no arguments. it just is. main character energy 👑

🦋 Public Member Functions inherited from SoBaseKit 🦋

all of these come free with the inheritance, bestie, you don't have to do a thing:

SoBaseKit (void)
virtual SoNode * getPart (const SbName &partname, SbBool makeifneeded)
SbString getPartString (const SoBase *part)
virtual SoNodeKitPath * createPathToPart (const SbName &partname, SbBool
    makeifneeded, const SoPath *pathtoextend=NULL)
virtual SbBool setPart (const SbName &partname, SoNode *from)
SbBool set (const char *namevaluepairliststring)
SbBool set (const char *partnamestring, const char *parameterstring)
virtual void doAction (SoAction *action)
virtual void callback (SoCallbackAction *action)
virtual void GLRender (SoGLRenderAction *action)
virtual void getBoundingBox (SoGetBoundingBoxAction *action)
virtual void getMatrix (SoGetMatrixAction *action)
virtual void handleEvent (SoHandleEventAction *action)
virtual void rayPick (SoRayPickAction *action)
virtual void search (SoSearchAction *action)
virtual void write (SoWriteAction *action)
virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action)
virtual SoChildList * getChildren (void) const
void printDiagram (void)
void printSubDiagram (const SbName &rootname, int level)
void printTable (void)
virtual void addWriteReference (SoOutput *out, SbBool isfromfield=FALSE)
SbBool forceChildDrivenWriteRefs (SoOutput *out)

🦋 Public Member Functions inherited from SoNode 🦋

the whole node buffet, lowkey a lot, but here it is, all of it, exactly:

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 audioRender (SoAudioRenderAction *action)
virtual void grabEventsSetup (void)
virtual void grabEventsCleanup (void)
virtual void startNotify (void)
virtual void notify (SoNotList *l)
uint32_t getNodeId (void) const
virtual void writeInstance (SoOutput *out)
virtual SoFieldContainer * copyThroughConnection (void) const

🦋 Public Member Functions inherited from SoFieldContainer 🦋

fields! fields! fields! 🌸

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)
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 root of it all, ref counting and friends:

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) — the class-level type id, static so you can grab it without an instance, slay ✨
  • static const SoNodekitCatalog * getClassNodekitCatalog (void) — the class-level nodekit catalog pointer 🎀
  • static void initClass (void) — the classic init hook, call it and everything's set up 💅

🦋 Static Public Member Functions inherited from SoBaseKit 🦋

static SoType getClassTypeId (void)
static void initClass (void)
static const SoNodekitCatalog * getClassNodekitCatalog (void)
static SbBool isSearchingChildren (void)
static void setSearchingChildren (const SbBool newval)

🦋 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 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)
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 *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)

💫 Protected Member Functions 💫

these are the ones that are, y'know, protected. family only. 🙈

virtual const SoFieldData * getFieldData (void) const
virtual ~SoCameraKit ()

🦋 Protected Member Functions inherited from SoBaseKit 🦋

virtual ~SoBaseKit ()
virtual SoNode * addToCopyDict (void) const
virtual void copyContents (const SoFieldContainer *fromfc, SbBool
    copyconnections)
SoGroup * getContainerNode (const SbName &listname, SbBool
    makeifneeded=TRUE)
virtual SoNode * getAnyPart (const SbName &partname, SbBool
    makeifneeded, SbBool leafcheck=FALSE, SbBool publiccheck=FALSE)
virtual SoNodeKitPath * createPathToAnyPart (const SbName &partname,
    SbBool makeifneeded, SbBool leafcheck=FALSE, SbBool
    publiccheck=FALSE, const SoPath *pathtoextend=NULL)
virtual SbBool setAnyPart (const SbName &partname, SoNode *from, SbBool
    anypart=TRUE)
void createNodekitPartsList (void)
void createFieldList (void)
virtual void createDefaultParts (void)
const SoNodekitParts * getNodekitPartsList (void) const
const SbList< SoSFNode * > & getCatalogInstances (void) const
void catalogError (void)
virtual SbBool setUpConnections (SbBool onoff, SbBool doitalways=FALSE)
virtual SbBool readInstance (SoInput *in, unsigned short flags)
virtual void setDefaultOnNonWritingFields (void)
void countMyFields (SoOutput *out)
virtual SbBool setPart (const int partNum, SoNode *node)

🦋 Protected Member Functions inherited from SoNode 🦋

SoNode (void)
virtual ~SoNode ()

🦋 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

💫 Static Protected Member Functions 💫

static const SoFieldData ** getFieldDataPtr (void)
static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void)

🦋 Static Protected Member Functions inherited from SoBaseKit 🦋

static const SoFieldData ** getFieldDataPtr (void)
static const SoNodekitCatalog ** getClassNodekitCatalogPtr (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)

💫 Protected Attributes 💫

these are the actual pieces of the kit, the moment honestly:

  • SoSFNode camera — the camera node field 📸
  • SoSFNode transform — the transform node field 🌀
  • SoSFNode transformGroup — and the transform group node field ✨

🦋 Protected Attributes inherited from SoBaseKit 🦋

SoSFNode callbackList
SoChildList * children
SbBool connectionsSetUp

🦋 Protected Attributes inherited from SoNode 🦋

uint32_t uniqueId

🦋 Protected Attributes inherited from SoFieldContainer 🦋

SbBool isBuiltIn

💫 Additional Inherited Members 💫

🦋 Public Types inherited from SoNode 🦋

the enum, all of it, every single value, don't blink:

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 }

and that's literally just the synopsis, bestie 😭 part 2 is coming with all the rest of it, so stay right here, don't scroll away, we're not done 💅✨

okay bestie we're picking right back up, no recap needed, let's get into the inherited-members corner of this class 💅✨

🌈 Protected Types (inherited, we love a hand-me-down) 🌈

  • inherited from SoBase:
enum BaseFlags { IS_ENGINE = 0x01, IS_GROUP = 0x02 }

🌟 Static Protected Attributes (also inherited) 🌟

  • inherited from SoNode:
static uint32_t nextUniqueId = 1
static int nextActionMethodIndex = 0

💖 Detailed Description 💖

so literally the whole point of SoCameraKit: it's a node kit that's got a transform and a camera in it. two things. living together. iconic roommates fr fr 🫶

here's the node kit structure, and the stuff that's new compared to the parent class gets an arrow --> in front of it, so you can tell what's fresh:

CLASS SoCameraKit
-->"this"
      "callbackList"
-->   "transformGroup"
-->      "transform"
-->      "camera"

if you wanna know more about how that diagram gets formatted when it prints, go peek at SoBaseKit::printDiagram(), it's all explained there 👑

and here's the detailed tea on the catalog parts, like what type each piece actually is:

CLASS SoCameraKit
PVT   "this",  SoCameraKit  ---
      "callbackList",  SoNodeKitListPart [ SoCallback, SoEventCallback ]
PVT   "transformGroup",  SoTransformSeparator  ---
      "transform",  SoTransform  ---
      "camera",  SoCamera  --- , (default type = SoPerspectiveCamera)

note that the "camera" part defaults to SoPerspectiveCamera, that's lowkey important, don't forget it 💀

and yeah, for the formatting of that table thing, SoBaseKit::printTable() has you covered ✨

🎀 Constructor & Destructor Documentation 🎀

🌸 SoCameraKit::SoCameraKit (void ) 🌸

Constructor. makes the thing. that's it, that's the job 💖

🌸 SoCameraKit::~SoCameraKit () [protected], [virtual] 🌸

Destructor. it's protected and virtual, mind you, so don't come for it from outside the family 🙈

✨ Member Function Documentation ✨

🌈 SoType SoCameraKit::getTypeId (void ) const [virtual] 🌈

okay so this one gives you back the type identification of an object that's derived from a class inheriting SoBase. what's that for?? run-time type checking and "downward" casting, bestie. that's the whole vibe.

usage example, here you go, keep it in your notes 📝:

void foo(SoNode * node)
{
  if (node->getTypeId() == SoFile::getClassTypeId()) {
    SoFile * filenode = (SoFile *)node;  // safe downward cast, knows the type
  }
}

now for all my application programmers out there who wanna extend the library with new nodes, engines, nodekits, draggers or whatever else: you have to override this method in all your subclasses. no skipping, it's giving required 💅

how you usually do it: as part of setting up the full type system for your extension classes, and that's normally done by using the pre-defined macros that are available through, for instance:

  • Inventor/nodes/SoSubNode.h — for node classes, that's SO_NODE_INIT_CLASS and SO_NODE_CONSTRUCTOR
  • Inventor/engines/SoSubEngine.h — for engine classes
  • and so on, you get the pattern 🦋

for even more info on writing Coin extensions, go read the class documentation of the toplevel superclasses for whichever class group you're in. slay.

Reimplemented from SoBaseKit.

🌈 const SoFieldData * SoCameraKit::getFieldData (void ) const [protected], [virtual] 🌈

hands you back a pointer to the class-wide field data storage object for this instance. and if there are no fields present at all? it returns NULL. that's it. that's the deal 🍓

Reimplemented from SoBaseKit.

🌈 const SoNodekitCatalog * SoCameraKit::getNodekitCatalog (void ) const [virtual] 🌈

this one returns the nodekit catalog that defines the layout of this class' kit — like the little blueprint of where everything goes 🧚

Reimplemented from SoBaseKit.

👑 Author 👑

Generated automatically by Doxygen for Coin from the source code. yeah, it's a robot-authored moment but we still stan the documentation, no cap 🤖💜

and that's the whole page, bestie!! this was Coin, Version 3.1.3, and this iconic lil entry is SoCameraKit(3) — go forth and build your cameras, you absolute main character 🎀💖✨🦋

📦 where this page comes from