Click or drag to resize
SoWrapperKit Class

Wrapper nodekit class.

Inheritance Hierarchy

Namespace: OIV.Inventor.Nodekits
Assembly: OIV.Inventor (in OIV.Inventor.dll) Version: 2024.2.0.0 (2024.2.0)
Syntax
public class SoWrapperKit : SoSeparatorKit

The SoWrapperKit type exposes the following members.

Constructors
  NameDescription
Public methodSoWrapperKit

Constructor.

Top
Methods
  NameDescription
Public methodAffectsState

Returns true if a node has an effect on the state during traversal.

(Inherited from SoNode.)
Public methodCallback
(Inherited from SoBaseKit.)
Public methodCopy
Calls Copy(false).
(Inherited from SoNode.)
Public methodCopy(Boolean)

Creates and returns an exact copy of the node.

(Inherited from SoNode.)
Public methodCopyFieldValues(SoFieldContainer)
Calls CopyFieldValues(fc, false).
(Inherited from SoFieldContainer.)
Public methodCopyFieldValues(SoFieldContainer, Boolean)

Copies the contents of fc's fields into this object's fields.

(Inherited from SoFieldContainer.)
Public methodCreatePathToPart(String, Boolean)
Calls CreatePathToPart(partName, makeIfNeeded, (OIV.Inventor.SoPath ^)nullptr).
(Inherited from SoBaseKit.)
Public methodCreatePathToPart(String, Boolean, SoPath)

Returns a path that begins at this nodekit and ends at partName.

(Inherited from SoBaseKit.)
Public methodDispose
Releases all resources used by SoDisposable.
(Inherited from SoDisposable.)
Public methodDistribute
(Inherited from SoNode.)
Public methodDoAction
(Inherited from SoBaseKit.)
Public methodEnableNotify

Notification at this Field Container is enabled (if flag == true) or disabled (if flag == false).

(Inherited from SoFieldContainer.)
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodFieldsAreEqual

Returns true if this object's fields are exactly equal to fc's fields.

(Inherited from SoFieldContainer.)
Public methodGet

Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string.

(Inherited from SoFieldContainer.)
Public methodGetAllFields

Returns a list of fields, including the eventIn's and eventOut's.

(Inherited from SoFieldContainer.)
Public methodGetAlternateRep

This method is called by actions to allow the node to provide an "alternate representation" when appropriate (typically depending on the action type).

(Inherited from SoNode.)
Public methodGetBoundingBox
(Inherited from SoBaseKit.)
Public methodStatic memberGetClassNodekitCatalog

Returns the OIV.Inventor.Nodekits.SoNodekitCatalog for this class.

Public methodGetEventIn

Returns a the eventIn with the given name.

(Inherited from SoFieldContainer.)
Public methodGetEventOut

Returns the eventOut with the given name.

(Inherited from SoFieldContainer.)
Public methodGetField

Returns a the field of this object whose name is fieldName.

(Inherited from SoFieldContainer.)
Public methodGetFieldName

Returns the name of the given field in the fieldName argument.

(Inherited from SoFieldContainer.)
Public methodGetFields

Appends references to all of this object's fields to resultList, and returns the number of fields appended.

(Inherited from SoFieldContainer.)
Public methodGetHashCode
Overrides GetHashCode().
(Inherited from SoNetBase.)
Public methodGetMatrix
(Inherited from SoBaseKit.)
Public methodGetName

Returns the name of an instance.

(Inherited from SoBase.)
Public methodGetNodekitCatalog (Inherited from SoBaseKit.)
Public methodGetPart

Searches the nodekit catalog (and those of all nested nodekits) for the part named partName.

(Inherited from SoBaseKit.)
Public methodGetPartString

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.

(Inherited from SoBaseKit.)
Public methodGetPrimitiveCount
(Inherited from SoBaseKit.)
Public methodGetRenderEngineMode

Returns the supported Render engine mode.

(Inherited from SoNode.)
Public methodGetRenderUnitID
(Inherited from SoNode.)
Public methodGetStringName (Inherited from SoBase.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetViewportIsEnabled (Inherited from SoBaseKit.)
Public methodGetViewportOrigin (Inherited from SoBaseKit.)
Public methodGetViewportSize (Inherited from SoBaseKit.)
Public methodGLRender
(Inherited from SoBaseKit.)
Public methodGLRenderBelowPath
(Inherited from SoNode.)
Public methodGLRenderInPath
(Inherited from SoNode.)
Public methodGLRenderOffPath
(Inherited from SoNode.)
Public methodGrabEventsCleanup
(Inherited from SoNode.)
Public methodGrabEventsSetup
(Inherited from SoNode.)
Public methodHandleEvent
(Inherited from SoBaseKit.)
Public methodHasDefaultValues

Returns true if all of the object's fields have their default values.

(Inherited from SoFieldContainer.)
Public methodIsBoundingBoxIgnoring

Returns true if bounding box computation should be ignored during OIV.Inventor.Actions.SoGetBoundingBoxAction traversal.

(Inherited from SoBaseKit.)
Public methodIsNotifyEnabled

Notification is the process of telling interested objects that this object has changed.

(Inherited from SoFieldContainer.)
Public methodIsOverride

Returns the state of the override flag.

(Inherited from SoNode.)
Public methodIsSynchronizable

Gets the ScaleViz synchronizable state of this object.

(Inherited from SoBase.)
Public methodPick
(Inherited from SoNode.)
Public methodRayPick
(Inherited from SoBaseKit.)
Public methodSearch
(Inherited from SoBaseKit.)
Public methodSet(String)

This function allows field values of parts (nodes) to be set in several different parts simultaneously.

(Inherited from SoBaseKit.)
Public methodSet(String, String)

This function allows field values of parts (nodes) to be set.

(Inherited from SoBaseKit.)
Public methodSetName (Inherited from SoBase.)
Public methodSetOverride

Turns the override flag on or off.

(Inherited from SoNode.)
Public methodSetPart

Inserts the given node (not a copy) as the new part specified by partName.

(Inherited from SoBaseKit.)
Public methodSetSynchronizable

Sets this to be a ScaleViz synchronizable object.

(Inherited from SoBase.)
Public methodSetToDefaults

Sets all fields in this object to their default values.

(Inherited from SoFieldContainer.)
Public methodToString
Converts this SoBase structure to a human readable string.
(Inherited from SoBase.)
Public methodTouch

Marks an instance as modified, simulating a change to it.

(Inherited from SoNode.)
Public methodWrite
(Inherited from SoBaseKit.)
Top
Properties
  NameDescription
Public propertyboundingBoxCaching
(Inherited from SoSeparatorKit.)
Public propertyboundingBoxIgnoring

Whether to ignore this node during bounding box traversal.

(Inherited from SoBaseKit.)
Public propertyIsDisposable
ISafeDisposable interface implementation.
(Inherited from SoDisposable.)
Public propertypickCulling

Set pick culling mode.

(Inherited from SoSeparatorKit.)
Public propertyrenderCaching Obsolete.

Set render caching mode.

(Inherited from SoSeparatorKit.)
Public propertyrenderCulling

Set render culling mode.

(Inherited from SoSeparatorKit.)
Public propertyUserData
Gets or sets the user data to be contained by the field container.
(Inherited from SoFieldContainer.)
Top
Remarks

OIV.Inventor.Nodekits.SoWrapperKit is derived from OIV.Inventor.Nodekits.SoSeparatorKit. It adds the capability to wrap an arbitrary scene graph, (non-nodekit), within an OIV.Inventor.Nodekits.SoSeparatorKit, so that it may be used along with other shape kits in a hierarchy. There are two additional parts included in OIV.Inventor.Nodekits.SoWrapperKit: localTransform and contents .

The part contents is an OIV.Inventor.Nodes.SoSeparator node beneath which any arbitrary scene graph can be added. This is especially useful for importing scene graphs of unknown structure (non-nodekits) into nodekit format.

Since an OIV.Inventor.Nodekits.SoWrapperKit is a class descended from OIV.Inventor.Nodekits.SoSeparatorKit, it may be put into another OIV.Inventor.Nodekits.SoSeparatorKit's childList .

PARTS

(OIV.Inventor.Nodes.SoTransform) localTransform This part is an OIV.Inventor.Nodes.SoTransform node that is used to affect the scene graph defined in contents part. This part is NULL by default and is automatically created if requested.

(OIV.Inventor.Nodes.SoSeparator) contents This part is an OIV.Inventor.Nodes.SoSeparator node that contains a user-supplied scene graph. This scene graph can contain any nodes. This part is NULL by default and an OIV.Inventor.Nodes.SoSeparator is automatically created if the user asks the nodekit to build the part.

FILE FORMAT/DEFAULT

WrapperKit {
boundingBoxCaching AUTO
renderCulling AUTO
pickCulling AUTO
callbackList NULL
pickStyle NULL
appearance NULL
units NULL
transform NULL
texture2Transform NULL
childList NULL
localTransform NULL
contents NULL
}

CATALOG PARTS

All Parts
Part NamePart TypeDefault TypeNULL Default
callbackList NodeKitListPart yes
pickStyle PickStyle yes
appearance AppearanceKit yes
units Units yes
transform Transform yes
texture2Transform Texture2Transform yes
childList NodeKitListPart yes
localTransform Transform yes
contents Separator yes

Extra Information for List Parts from Above Table
Part NameContainer TypePossible Types
callbackList Separator Callback, EventCallback

See Also