SOSCENEKIT(3iv)

🌸 NAME 🌸

SoSceneKit — scene nodekit class 💅

okay so quick vibe check: this is the SoSceneKit(3IV) page, and it's literally the nodekit that pulls your cameras, your lights and your objects into one whole scene. main character energy, no cap.

---

🦋 INHERITS FROM 🦋

SoBase > SoFieldContainer > SoNode > SoBaseKit > SoSceneKit

it's giving "deep family tree" and honestly? iconic lineage.

---

✨ SYNOPSIS ✨

#include <Inventor/nodekits/SoSceneKit.h>

🎀 Parts from class SoSceneKit

(SoNodeKitListPart)  cameraList
(SoNodeKitListPart)  lightList
(SoNodeKitListPart)  childList

🎀 Parts from class SoBaseKit

(SoNodeKitListPart)  callbackList

🎀 Methods from class SoSceneKit

                     SoSceneKit()
 static const SoNodekitCatalog *
                     getClassNodekitCatalog() const
 int                 getCameraNumber()
 void                setCameraNumber(int camNum)
 static SoType       getClassTypeId()

🎀 Methods from class SoBaseKit

 virtual const SoNodekitCatalog *
                          getNodekitCatalog() const
 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 *newPart)
 SbBool                   set(char *partName, char *parameters)
 SbBool                   set(char *nameValuePairs)
 static SbBool            isSearchingChildren()
 static void              setSearchingChildren(SbBool newVal)

🎀 Methods from class SoNode

 void                setOverride(SbBool state)
 SbBool              isOverride() const
 SoNode *            copy(SbBool copyConnections = FALSE) const
 virtual SbBool      affectsState() const
 static SoNode *     getByName(const SbName &name)
 static int          getByName(const SbName &name, SoNodeList &list)

🎀 Methods from class SoFieldContainer

 void                setToDefaults()
 SbBool              hasDefaultValues() const
 SbBool              fieldsAreEqual(const SoFieldContainer *fc) const
 void                copyFieldValues(const SoFieldContainer *fc, SbBool
                          copyConnections = FALSE)
 void                get(SbString &fieldDataString)
 virtual int         getFields(SoFieldList &resultList) const
 virtual SoField *   getField(const SbName &fieldName) const
 SbBool              getFieldName(const SoField *field, SbName &fieldName)
                          const
 SbBool              isNotifyEnabled() const
 SbBool              enableNotify(SbBool flag)

🎀 Methods from class SoBase

 void                ref()
 void                unref() const
 void                unrefNoDelete() const
 void                touch()
 virtual SoType      getTypeId() const
 SbBool              isOfType(SoType type) const
 virtual void        setName(const SbName &name)
 virtual SbName      getName() const

🎀 Macros from class SoBaseKit

 SO_GET_PART(kit, partName, partClass)
 SO_CHECK_PART(kit, partName, partClass)

---

💖 DESCRIPTION 💖

so bestie, this nodekit is the one that organizes camera nodekits (SoCameraKit), light nodekits (SoLightKit), and object nodekits (SoShapeKit, SoSeparatorKit, and SoWrapperKit) into a whole scene. a scene is composed of a list of cameras, a list of lights, and a list of children. there are three parts created by this nodekit: cameraList, lightList, and childList. that's the trio. the holy trinity. 🫶

the cameraList part is a list part of SoCameraKit nodes. the list itself is an SoNodeKitListPart, and since only one camera can be active at a time, the container of the list part is an SoSwitch node. use setCameraNumber(), and the scene kit will set the switch to make that camera active. so it's giving "one camera on aux at a time" 🎥

the lightList part is a list of SoLightKit nodes. the lightList is used to illuminate the objects contained in the childList part. literally the lighting department. ✨

the childList part contains a set of SoSeparatorKit nodes. you can add any kind of SoSeparatorKit to this list, including SoShapeKit and SoWrapperKit. since each SoSeparatorKit in turn contains a childList, this part is used to describe a hierarchical scene. (see the reference page for SoSeparatorKit). all members of childList are lit by the lights in lightList and rendered by the active camera in cameraList. it's a whole ecosystem fr fr. 🌈

---

🎀 PARTS 🎀

• (SoNodeKitListPart) cameraList — this part is an SoNodeKitListPart. it has a container that is an SoSwitch node. the list may contain only SoCameraKit nodekits. the active child of the SoSwitch is the active camera. this part is NULL by default, but is automatically created whenever you add a camera, as with setPart("cameraList[0]", myNewCamera) .
• (SoNodeKitListPart) lightList — this part is an SoNodeKitListPart that uses an defines an SoGroup as its container. the list may contain only SoLightKit nodekits. add SoLightKits to this list and they will light the members of the childList of this SoSceneKit. this part is NULL by default, but is automatically created when you add a light. 💡
• (SoNodeKitListPart) childList — this part is an SoNodeKitListPart that uses an SoGroup for its container. the list may contain only SoSeparatorKit nodekits or nodekits derived from SoSeparatorKit (e.g., SoShapeKit and SoWrapperKit). these children represent the objects in the scene. this part is NULL by default, but is automatically created whenever you add a child to the childList. also, when asked to build a member of the childList, the scenekit will build an SoShapeKit by default. so if the childList part is NULL, and you call: getPart("childList[0]", TRUE) . the scene kit will create the childList and add an SoShapeKit as the new element in the list. 🍓

---

💅 METHODS 💅

• SoSceneKit() — constructor. the classic. the origin story. ✨
• static const SoNodekitCatalog * getClassNodekitCatalog() const — returns an SoNodekitCatalog for the class SoSceneKit.
• int getCameraNumber() and void setCameraNumber(int camNum) — gets and sets current camera index. this index refers to which child is active in the cameraList part (SoSwitch node). 📸
• static SoType getClassTypeId() — returns type identifier for this class.

---

👑 CATALOG PARTS 👑

All parts

• callbackList — part type: NodeKitListPart — default type: -- — NULL by default: yes
• cameraList — part type: NodeKitListPart — default type: -- — NULL by default: yes
• lightList — part type: NodeKitListPart — default type: -- — NULL by default: yes
• childList — part type: NodeKitListPart — default type: -- — NULL by default: yes

Extra information for list parts from above table

• callbackList — container type: Separator — permissible types: Callback, EventCallback
• cameraList — container type: Switch — permissible types: CameraKit
• lightList — container type: Group — permissible types: LightKit
• childList — container type: Group — permissible types: ShapeKit, SeparatorKit

---

🌟 FILE FORMAT/DEFAULTS 🌟

SceneKit {
   callbackList  NULL
   cameraList    NodeKitListPart {
       containerTypeName "Switch"     childTypeNames "CameraKit"     containerNode     Switch {
                 whichChild 0 CameraKit {
                     camera     PerspectiveCamera {
                     }
                  }
       }
    }

   lightList     NULL
   childList     NULL
}

---

🫶 SEE ALSO 🫶

SoAppearanceKit, SoBaseKit, SoCameraKit, SoLightKit, SoNodeKit, SoNodeKitDetail, SoNodeKitListPart, SoNodeKitPath, SoNodekitCatalog, SoSeparatorKit, SoShapeKit, SoWrapperKit

---

ok that's the whole page, nothing skipped, every flag and signature intact 💯

and that's a wrap on the SoSceneKit(3IV) page, bestie — source and version is the SoSceneKit(3IV)() footer, and yeah the date slot is literally empty, we're leaving it blank and mysterious on purpose 😌✨ go build your scene, you got this 💖🎀🦋