| SoLightKit Class |
Light nodekit class.
Inheritance HierarchyOIV.InventorSoNetBase
OIV.InventorSoDisposable
OIV.Inventor.MiscSoBase
OIV.Inventor.FieldsSoFieldContainer
OIV.Inventor.NodesSoNode
OIV.Inventor.NodekitsSoBaseKit
OIV.Inventor.NodekitsSoLightKit
Namespace: OIV.Inventor.Nodekits
Assembly: OIV.Inventor (in OIV.Inventor.dll) Version: 2023.1.3.0 (2023.1.3)
SyntaxThe SoLightKit type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | SoLightKit | Constructor. |
Methods| 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.) |
 | 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. |
| 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.) |
Properties| 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.) |
RemarksThis nodekit class is used to create light nodes that have a local transformation and a geometry icon to represent the light source. OIV.Inventor.Nodekits.SoLightKit adds three public parts to the basic nodekit: transform , light , and icon .
OIV.Inventor.Nodekits.SoLightKit creates an OIV.Inventor.Nodes.SoDirectionalLight as the light part by default - all other parts are NULL at creation.
You can move the light relative to the rest of the scene by creating and editing the transform part.
You can add a geometrical representation for the light by setting the icon part to be any scene graph you like.
OIV.Inventor.Nodekits.SoLightKit also adds two private parts. An OIV.Inventor.Nodes.SoTransformSeparator contains the effect of transform to move only the light and icon , while allowing the light to illuminate the rest of the scene. The second private part is an OIV.Inventor.Nodes.SoSeparator, which keeps property nodes within the icon geometry from affecting the rest of the scene. It also serves to cache the icon even when the light or transform is changing.
OIV.Inventor.Nodekits.SoLightKit is derived from OIV.Inventor.Nodekits.SoBaseKit and thus also includes a callbackList part for adding callback nodes.
PARTS
(OIV.Inventor.Nodes.SoTransform) transform This part positions and orients the light and icon relative to the rest of the scene. Its effect is kept local to this nodekit by a private part of type OIV.Inventor.Nodes.SoTransformSeparator. The transform part is NULL by default. If you ask for transform using OIV.Inventor.Nodekits.SoBaseKit.GetPart(System.String, System.Boolean), an OIV.Inventor.Nodes.SoTransform will be returned. But you may set the part to be any subclass of OIV.Inventor.Nodes.SoTransform. For example, set the transform to be an SoDragPointManip and the light to be an OIV.Inventor.Nodes.SoPointLight. Then you can move the light by dragging the manipulator with the mouse.
(OIV.Inventor.Nodes.SoLight) light The light node for this nodekit. This can be set to any node derived from OIV.Inventor.Nodes.SoLight. An OIV.Inventor.Nodes.SoDirectionalLight is created by default, and it is also the type of light returned when the you request that the nodekit build a light for you.
(OIV.Inventor.Nodes.SoNode) icon This part is a user-supplied scene graph that represents the light source. It is NULL by default - an OIV.Inventor.Nodes.SoCube is created by the lightkit when a method requires it to build the part itself.
FILE FORMAT/DEFAULT
LightKit {
| callbackList | NULL |
| transform | NULL |
| light | DirectionalLight { |
| } | |
| icon | NULL |
CATALOG PARTS
All Parts
| Part Name | Part Type | Default Type | NULL Default |
| callbackList | NodeKitListPart | yes | |
| transform | Transform | yes | |
| light | Light | DirectionalLight | no |
| icon | Node | Cube | yes |
Extra Information for List Parts from Above Table
| Part Name | Container Type | Possible Types |
| callbackList | Separator | Callback, EventCallback |
See Also