SoSceneKit Class |
Scene nodekit class.
Namespace: OIV.Inventor.Nodekits
The SoSceneKit type exposes the following members.
Name | Description | |
---|---|---|
SoSceneKit | Constructor. |
Name | Description | |
---|---|---|
AffectsState | Returns true if a node has an effect on the state during traversal. | |
Callback | (Inherited from SoBaseKit.) | |
Copy | Calls Copy(false). (Inherited from SoNode.) | |
Copy(Boolean) | Creates and returns an exact copy of the node. | |
CopyFieldValues(SoFieldContainer) | Calls CopyFieldValues(fc, false). (Inherited from SoFieldContainer.) | |
CopyFieldValues(SoFieldContainer, Boolean) | Copies the contents of fc's fields into this object's fields. | |
CreatePathToPart(String, Boolean) | Calls CreatePathToPart(partName, makeIfNeeded, (OIV.Inventor.SoPath ^)nullptr). (Inherited from SoBaseKit.) | |
CreatePathToPart(String, Boolean, SoPath) | Returns a path that begins at this nodekit and ends at partName. | |
Dispose |
Releases all resources used by SoDisposable.
(Inherited from SoDisposable.) | |
Distribute | (Inherited from SoNode.) | |
DoAction | (Inherited from SoBaseKit.) | |
EnableNotify | Notification at this Field Container is enabled (if flag == true) or disabled (if flag == false). | |
Equals | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) | |
FieldsAreEqual | Returns true if this object's fields are exactly equal to fc's fields. | |
Get | Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string. | |
GetAllFields | Returns a list of fields, including the eventIn's and eventOut's. | |
GetAlternateRep | This method is called by actions to allow the node to provide an "alternate representation" when appropriate (typically depending on the action type). | |
GetBoundingBox | (Inherited from SoBaseKit.) | |
GetCameraNumber | Gets current camera index. | |
GetClassNodekitCatalog | Returns the OIV.Inventor.Nodekits.SoNodekitCatalog for this class. | |
GetEventIn | Returns a the eventIn with the given name. | |
GetEventOut | Returns the eventOut with the given name. | |
GetField | Returns a the field of this object whose name is fieldName. | |
GetFieldName | Returns the name of the given field in the fieldName argument. | |
GetFields | Appends references to all of this object's fields to resultList, and returns the number of fields appended. | |
GetHashCode |
Overrides GetHashCode().
(Inherited from SoNetBase.) | |
GetMatrix | (Inherited from SoBaseKit.) | |
GetName | Returns the name of an instance. | |
GetNodekitCatalog | Returns the OIV.Inventor.Nodekits.SoNodekitCatalog for this instance of OIV.Inventor.Nodekits.SoBaseKit. | |
GetPart | Searches the nodekit catalog (and those of all nested nodekits) for the part named partName. | |
GetPartString | Given a node or a path to a node, checks if the part exists in the nodekit, in a nested nodekit, or an element of a list part. | |
GetPrimitiveCount | (Inherited from SoBaseKit.) | |
GetRenderEngineMode | Returns the supported Render engine mode. | |
GetRenderUnitID | (Inherited from SoNode.) | |
GetStringName | (Inherited from SoBase.) | |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
GetViewportIsEnabled | (Inherited from SoBaseKit.) | |
GetViewportOrigin | (Inherited from SoBaseKit.) | |
GetViewportSize | (Inherited from SoBaseKit.) | |
GLRender | (Inherited from SoBaseKit.) | |
GLRenderBelowPath | (Inherited from SoNode.) | |
GLRenderInPath | (Inherited from SoNode.) | |
GLRenderOffPath | (Inherited from SoNode.) | |
GrabEventsCleanup | (Inherited from SoNode.) | |
GrabEventsSetup | (Inherited from SoNode.) | |
HandleEvent | (Inherited from SoBaseKit.) | |
HasDefaultValues | Returns true if all of the object's fields have their default values. | |
IsBoundingBoxIgnoring | Returns true if bounding box computation should be ignored during OIV.Inventor.Actions.SoGetBoundingBoxAction traversal. | |
IsNotifyEnabled | Notification is the process of telling interested objects that this object has changed. | |
IsOverride | Returns the state of the override flag. | |
IsSynchronizable | Gets the ScaleViz synchronizable state of this object. | |
Pick | (Inherited from SoNode.) | |
RayPick | (Inherited from SoBaseKit.) | |
Search | (Inherited from SoBaseKit.) | |
Set(String) | This function allows field values of parts (nodes) to be set in several different parts simultaneously. | |
Set(String, String) | This function allows field values of parts (nodes) to be set. | |
SetCameraNumber | Sets current camera index. | |
SetName | (Inherited from SoBase.) | |
SetOverride | Turns the override flag on or off. | |
SetPart | Inserts the given node (not a copy) as the new part specified by partName. | |
SetSynchronizable | Sets this to be a ScaleViz synchronizable object. | |
SetToDefaults | Sets all fields in this object to their default values. | |
ToString |
Converts this SoBase structure to a human readable string.
(Inherited from SoBase.) | |
Touch | Marks an instance as modified, simulating a change to it. | |
Write | (Inherited from SoBaseKit.) |
Name | Description | |
---|---|---|
boundingBoxIgnoring | Whether to ignore this node during bounding box traversal. | |
IsDisposable | ISafeDisposable interface implementation.
(Inherited from SoDisposable.) | |
UserData |
Gets or sets the user data to be contained by the field container.
(Inherited from SoFieldContainer.) |
This nodekit is used to organize camera, (OIV.Inventor.Nodekits.SoCameraKit), light, (OIV.Inventor.Nodekits.SoLightKit), and object, (OIV.Inventor.Nodekits.SoShapeKit, OIV.Inventor.Nodekits.SoSeparatorKit, and OIV.Inventor.Nodekits.SoWrapperKit) nodekits into a 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 .
The cameraList part is a list part of OIV.Inventor.Nodekits.SoCameraKit nodes. The list itself is an OIV.Inventor.Nodekits.SoNodeKitListPart, and since only one camera can be active at a time, the container of the list part is an OIV.Inventor.Nodes.SoSwitch node. Use OIV.Inventor.Nodekits.SoSceneKit.SetCameraNumber(System.Int32), and the scene kit will set the switch to make that camera active.
The lightList part is a list of OIV.Inventor.Nodekits.SoLightKit nodes. The lightList is used to illuminate the objects contained in the childList part.
The childList part contains a set of OIV.Inventor.Nodekits.SoSeparatorKit nodes. You can add any kind of OIV.Inventor.Nodekits.SoSeparatorKit to this list, including OIV.Inventor.Nodekits.SoShapeKit and OIV.Inventor.Nodekits.SoWrapperKit. Since each OIV.Inventor.Nodekits.SoSeparatorKit in turn contains a childList , this part is used to describe a hierarchical scene. (See the reference page for OIV.Inventor.Nodekits.SoSeparatorKit). All members of childList are lit by the lights in lightList and rendered by the active camera in cameraList .
NOTES:
By default the viewer will not find the camera inside the OIV.Inventor.Nodekits.SoCameraKit. To allow the viewer to find this camera the application must explicitly allow searching inside nodekits by calling the OIV.Inventor.Nodekits.SoBaseKit static method setSearchingChildren. If the viewer does not find a camera in the scene graph it will create one automatically and attach to the created one.
If the viewer does find the camera inside the OIV.Inventor.Nodekits.SoCameraKit, the viewer will not call its viewAll() method automatically. The application must make this call.
(OIV.Inventor.Nodekits.SoNodeKitListPart) cameraList This part is an OIV.Inventor.Nodekits.SoNodeKitListPart It has a container that is an OIV.Inventor.Nodes.SoSwitch node. The list may contain only OIV.Inventor.Nodekits.SoCameraKit nodekits. The active child of the OIV.Inventor.Nodes.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) .
(OIV.Inventor.Nodekits.SoNodeKitListPart) lightList This part is an OIV.Inventor.Nodekits.SoNodeKitListPart that uses an defines an OIV.Inventor.Nodes.SoGroup as its container The list may contain only OIV.Inventor.Nodekits.SoLightKit nodekits. Add SoLightKits to this list and they will light the members of the childList of this OIV.Inventor.Nodekits.SoSceneKit. This part is NULL by default, but is automatically created when you add a light.
(OIV.Inventor.Nodekits.SoNodeKitListPart) childList This part is an OIV.Inventor.Nodekits.SoNodeKitListPart that uses an OIV.Inventor.Nodes.SoGroup for its container. The list may contain only OIV.Inventor.Nodekits.SoSeparatorKit nodekits or nodekits derived from OIV.Inventor.Nodekits.SoSeparatorKit (e.g., OIV.Inventor.Nodekits.SoShapeKit and OIV.Inventor.Nodekits.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 OIV.Inventor.Nodekits.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 OIV.Inventor.Nodekits.SoShapeKit as the new element in the list.
SceneKit {
callbackList | NULL | |||
cameraList NodeKitListPart { | ||||
containerTypeName | "Switch" | |||
childTypeNames | "CameraKit" | |||
containerNode | Switch { | |||
whichChild 0 | ||||
CameraKit { | ||||
camera PerspectiveCamera {} | ||||
} | ||||
} | ||||
} | ||||
lightList | NULL | |||
childList | NULL |
All Parts
Part Name | Part Type | Default Type | NULL Default |
callbackList | NodeKitListPart | yes | |
cameraList | NodeKitListPart | yes | |
lightList | NodeKitListPart | yes | |
childList | NodeKitListPart | yes |
Extra Information for List Parts from Above Table
Part Name | Container Type | Possible Types |
callbackList | Separator | Callback, EventCallback |