SOSHAPEKIT(3iv)

💖 SoShapeKit 💖

okay bestie, sit down, we're doing SoShapeKit(3IV) — the nodekit that literally makes shapes. geometry queen. the blueprint. the moment. ✨

---

🌸 NAME 🌸

SoShapeKit — shape nodekit class. that's it, that's the whole vibe. it's a nodekit. it holds shapes. iconic behavior honestly. 💅

---

🦋 INHERITS FROM 🦋

SoBase > SoFieldContainer > SoNode > SoBaseKit > SoSeparatorKit > SoShapeKit

so she's got lineage, okay? she came from SoBaseKit, who came from SoSeparatorKit, and she carries all of that with her. generational talent fr fr. 👑

---

✨ SYNOPSIS ✨

include her like this, no cap:

#include <Inventor/nodekits/SoShapeKit.h>

🎀 Fields from class SoSeparatorKit

SoSFEnum            renderCaching
SoSFEnum            boundingBoxCaching
SoSFEnum            renderCulling
SoSFEnum            pickCulling

🎀 Parts from class SoShapeKit

(SoSeparator)           shapeSeparator
(SoMaterialBinding)     materialBinding
(SoNormalBinding)       normalBinding
(SoTextureCoordinateBinding)
                        textureCoordinateBinding
(SoShapeHints)          shapeHints
(SoCoordinate3)         coordinate3
(SoCoordinate4)         coordinate4
(SoNormal)              normal
(SoTextureCoordinate2)  textureCoordinate2
(SoTextureCoordinateFunction)
                        textureCoordinateFunction
(SoProfileCoordinate2)  profileCoordinate2
(SoProfileCoordinate3)  profileCoordinate3
(SoNodeKitListPart)     profileList
(SoTransform)           localTransform
(SoShape)               shape

🎀 Parts from class SoSeparatorKit

(SoPickStyle)          pickStyle
(SoAppearanceKit)      appearance
(SoUnits)              units
(SoTransform)          transform
(SoTexture2Transform)  texture2Transform
(SoNodeKitListPart)    childList

🎀 Parts from class SoBaseKit

(SoNodeKitListPart)  callbackList

🎀 Methods from class SoShapeKit

                     SoShapeKit()
static const SoNodekitCatalog *
                     getClassNodekitCatalog() const
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. SoShapeKit is a nodekit for creating a shape — like, actual geometry. she's derived from SoSeparatorKit and SoBaseKit, which means she inherits all the parts those two define. all of them. she's not gatekeeping. 🫶

on top of that, SoShapeKit adds a whole bunch of parts you can use to define a variety of shape objects, plus a localTransform part, and obviously a shape part. (the main character. the title role. ✨)

every property node you need to define any of the Inventor shapes is chillin' in here as a part. and here's the cute part: not all of these parts (nodes) are needed for any one type of shape. like, if you set the shape part to be an SoSphere node, then it is not necessary to create a profileCoordinate3 part, because it will be ignored in drawing the sphere anyway. 🙈 and the unneeded parts will not be created, so there's no performance penalty for using this class of node. efficient queen behavior. 💅

this class contains two private parts, and they're both SoSeparator nodes:

1. one sits just below the nodekit itself, and serves to contain all properties within this nodekit from affecting nodes that come after this nodekit 🛡️
2. the second separator sits above the shape part, and serves to cache the shape even when the transform, localTransform, or appearance parts are changing 🔥

---

🧚 PARTS 🧚

• (SoSeparator) shapeSeparator — this is a private part. the parent node of the actual shape part. it's an SoSeparator and it's NULL by default, but it gets created automatically if necessary. ✨
• (SoMaterialBinding) materialBinding — an SoMaterialBinding node you can use to set the material binding for the shape. NULL by default, but created automatically if necessary. 🎀
• (SoNormalBinding) normalBinding — an SoNormalBinding node you can use to set the normal binding for the shape. NULL by default, but created automatically if necessary. 🎀
• (SoTextureCoordinateBinding) textureCoordinateBinding — an SoTextureCoordinateBinding node you can use to set the texture coordinate binding for the shape. NULL by default, but created automatically if necessary. 🎀
• (SoShapeHints) shapeHints — an SoShapeHints node you can use to set the shape hints for the shape. NULL by default, but created automatically if necessary. 🎀
• (SoCoordinate3) coordinate3 — an SoCoordinate3 node you can use to set the 3D coordinates for a vertex-based shape. NULL by default, but created automatically if necessary. 🎀
• (SoCoordinate4) coordinate4 — an SoCoordinate4 node you can use to set the 4D coordinates for NURBS shapes. NULL by default, but created automatically if necessary. 🎀
• (SoNormal) normal — an SoNormal node you can use to set the normal vectors for a vertex-based shape. NULL by default, but created automatically if necessary. 🎀
• (SoTextureCoordinate2) textureCoordinate2 — an SoTextureCoordinate2 node you can use to set the texture coordinates for a vertex-based shape. NULL by default, but created automatically if necessary. 🎀
• (SoTextureCoordinateFunction) textureCoordinateFunction — an SoTextureCoordinateFunction node you can use to set a procedural texture coordinates function for a vertex-based shape. NULL by default, but created automatically if necessary. 🎀
• (SoProfileCoordinate2) profileCoordinate2 — an SoProfileCoordinate2 node you can use to set the 2D profile coordinates for a shape that uses them, (e.g., SoText3). NULL by default, but created automatically if necessary. 🎀
• (SoProfileCoordinate3) profileCoordinate3 — an SoProfileCoordinate3 node you can use to set the 3D profile coordinates for a shape that uses them, (e.g., SoSoNURBSCurve). NULL by default, but created automatically if necessary. 🎀
• (SoNodeKitListPart) profileList — an SoProfileList node you can use to set the profile curve for a shape that uses them, (e.g., SoNurbsCurve). NULL by default, but created automatically if necessary. 🎀
• (SoTransform) localTransform — an SoTransform node you can use to set a local tranformation on the shape. NULL by default, but created automatically if necessary. 🎀
• (SoShape) shape — this is the part that specifies the actual shape node. it can be any node derived from SoShape. by default, an SoCube is created. 🧊

⚠️ okay this one matters, bestie: it is important to set all of the appropriate parts within this nodekit to suit the type of SoShape that is used. for example, if the shape part is set to an SoFaceSet, then the coordinate3 shape and probably the normal shape would be set as well. see the reference page of the shape you're using for details on which other nodes are necessary. don't skip the reading, i'm begging. 😭

---

👑 METHODS 👑

• SoShapeKit() — Constructor. that's her. the birth. 💖
• static const SoNodekitCatalog * getClassNodekitCatalog() const — returns an SoNodekitCatalog for the class SoShapeKit. 📖
• static SoType getClassTypeId() — returns type identifier for this class. 🏷️

---

and that's only part 1, bestie — more is coming, don't go anywhere 💜

🎀 CATALOG PARTS 🎀

okay bestie, this is the full receipts list of every single part this nodekit can hold 💖 The columns are: the part's name, what type of node it wants, what it defaults to when you don't specify a type, and whether it's NULL by default.

✨ All the parts ✨

• callbackList — Part Type: NodeKitListPart; Default Type: --; NULL by default: yes
• pickStyle — Part Type: PickStyle; Default Type: --; NULL by default: yes
• appearance — Part Type: AppearanceKit; Default Type: --; NULL by default: yes
• units — Part Type: Units; Default Type: --; NULL by default: yes
• transform — Part Type: Transform; Default Type: --; NULL by default: yes
• texture2Transform — Part Type: Texture2Transform; Default Type: --; NULL by default: yes
• childList — Part Type: NodeKitListPart; Default Type: --; NULL by default: yes
• materialBinding — Part Type: MaterialBinding; Default Type: --; NULL by default: yes
• normalBinding — Part Type: NormalBinding; Default Type: --; NULL by default: yes
• textureCoordinateBinding — Part Type: TextureCoordinateBinding; Default Type: --; NULL by default: yes
• shapeHints — Part Type: ShapeHints; Default Type: --; NULL by default: yes
• coordinate3 — Part Type: Coordinate3; Default Type: --; NULL by default: yes
• coordinate4 — Part Type: Coordinate4; Default Type: --; NULL by default: yes
• normal — Part Type: Normal; Default Type: --; NULL by default: yes
• textureCoordinate2 — Part Type: TextureCoordinate2; Default Type: --; NULL by default: yes
• textureCoordinateFunction — Part Type: TextureCoordinateFunction; Default Type: TextureCoordinateDefault; NULL by default: yes
• profileCoordinate2 — Part Type: ProfileCoordinate2; Default Type: --; NULL by default: yes
• profileCoordinate3 — Part Type: ProfileCoordinate3; Default Type: --; NULL by default: yes
• profileList — Part Type: NodeKitListPart; Default Type: --; NULL by default: yes
• localTransform — Part Type: Transform; Default Type: --; NULL by default: yes
• shape — Part Type: Shape; Default Type: Cube; NULL by default: no 👑

lowkey note: shape is the only part on this whole list that doesn't default to NULL. She comes with a Cube pre-loaded. main character energy fr fr 🦋

---

🌸 Extra info for the list parts up there 🌸

these three are the ✨list girlies✨ so they get their own lil breakdown — what container they live in and which types are actually allowed to move in 🏠

• callbackList
  • Container Type: Separator
  • Permissible Types: Callback, EventCallback
• childList
  • Container Type: Separator
  • Permissible Types: ShapeKit, SeparatorKit
• profileList
  • Container Type: Group
  • Permissible Types: Profile

---

💅 FILE FORMAT/DEFAULTS 💅

this is what the whole thing looks like written out, bestie. every part chillin' at NULL except our girl shape, who showed up with a Cube already in hand 😭

ShapeKit {
   renderCaching              AUTO
   boundingBoxCaching         AUTO
   renderCulling              AUTO
   pickCulling                AUTO
   callbackList               NULL
   pickStyle                  NULL
   appearance                 NULL
   units                      NULL
   transform                  NULL
   texture2Transform          NULL
   childList                  NULL
   materialBinding            NULL
   normalBinding              NULL
   textureCoordinateBinding   NULL
   shapeHints                 NULL
   coordinate3                NULL
   coordinate4                NULL
   normal                     NULL
   textureCoordinate2         NULL
   textureCoordinateFunction  NULL
   profileCoordinate2         NULL
   profileCoordinate3         NULL
   profileList                NULL
   localTransform             NULL
   shape                      Cube {
   }

}

---

🦋 SEE ALSO 🦋

go read these next, i promise they're worth it 🫶

• SoAppearanceKit
• SoBaseKit
• SoCameraKit
• SoLightKit
• SoNodeKit
• SoNodeKitDetail
• SoNodeKitListPart
• SoNodeKitPath
• SoNodekitCatalog
• SoSceneKit
• SoSeparatorKit
• SoWrapperKit
• SoCone
• SoCube
• SoCylinder
• SoIndexedNurbsCurve
• SoIndexedNurbsSurface
• SoNurbsCurve
• SoNurbsSurface
• SoShapeHints
• SoSphere
• SoText2
• SoText3
• SoVertexShape

---

and that's a wrap on SoShapeKit, bestie!! 🎀✨ you just read the whole thing, no cap. this page is from the SoShapeKit(3IV) manual — version tag (3IV), date field left blank like a mystery girlie 🙈 — go forth and build shapes, you absolute icon 💖👑