SoDirectionalLightDragger Class |
Directional icon you rotate and translate by dragging with the mouse.
Namespace: OIV.Inventor.Draggers
The SoDirectionalLightDragger type exposes the following members.
Name | Description | |
---|---|---|
SoDirectionalLightDragger | Constructor. |
Name | Description | |
---|---|---|
AffectsState | Returns true if a node has an effect on the state during traversal. | |
Callback | (Inherited from SoBaseKit.) | |
ClearOtherEventCallbacks | (Inherited from SoDragger.) | |
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. | |
CreatePathToThis | (Inherited from SoDragger.) | |
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). | |
EnableValueChangedEvent | You can temporarily disable a dragger's valueChangedCallbacks. | |
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. | |
GetEvent | (Inherited from SoDragger.) | |
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. | |
GetHandleEventAction | (Inherited from SoDragger.) | |
GetHashCode |
Overrides GetHashCode().
(Inherited from SoNetBase.) | |
GetLocalStartingPoint | (Inherited from SoDragger.) | |
GetLocalToWorldMatrix | Calls GetLocalToWorldMatrix((OIV.Inventor.Actions.SoAction ^)nullptr). (Inherited from SoDragger.) | |
GetLocalToWorldMatrix(SoAction) | (Inherited from SoDragger.) | |
GetMatrix | (Inherited from SoBaseKit.) | |
GetMinGesture | Gets the number of pixels of movement required to initiate a constraint gesture. | |
GetMinGestureFloat | Float version of OIV.Inventor.Draggers.SoDragger.GetMinGesture(). | |
GetMotionMatrix | Get the motion matrix. | |
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. | |
GetPartToLocalMatrix | (Inherited from SoDragger.) | |
GetPickPath | (Inherited from SoDragger.) | |
GetPrimitiveCount | (Inherited from SoBaseKit.) | |
GetRenderEngineMode | Returns the supported Render engine mode. | |
GetRenderUnitID | (Inherited from SoNode.) | |
GetStartMotionMatrix | (Inherited from SoDragger.) | |
GetStringName | (Inherited from SoBase.) | |
GetSurrogatePartPickedName | (Inherited from SoDragger.) | |
GetSurrogatePartPickedOwner | (Inherited from SoDragger.) | |
GetSurrogatePartPickedPath | (Inherited from SoDragger.) | |
GetTrackerDirectMode | Get the current tracker direct mode for this dragger. | |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
GetViewportIsEnabled | (Inherited from SoBaseKit.) | |
GetViewportOrigin | (Inherited from SoBaseKit.) | |
GetViewportRegion | Obsolete. (Inherited from SoDragger.) | |
GetViewportSize | (Inherited from SoBaseKit.) | |
GetViewVolume | Obsolete. Dragger must not store information related to viewer settings. | |
GetWorldStartingPoint | (Inherited from SoDragger.) | |
GetWorldToLocalMatrix | Calls GetWorldToLocalMatrix((OIV.Inventor.Actions.SoAction ^)nullptr). (Inherited from SoDragger.) | |
GetWorldToLocalMatrix(SoAction) | (Inherited from SoDragger.) | |
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. | |
InvokeValueChanged | (Inherited from SoDragger.) | |
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. | |
IsPathSurrogateInMySubgraph(SoPath) | (Inherited from SoInteractionKit.) | |
IsPathSurrogateInMySubgraph(SoPath, SoPath, String, SoPath) | Calls IsPathSurrogateInMySubgraph(pathToCheck, pathToOwner, surrogateNameInOwner, surrogatePathInOwner, true). (Inherited from SoInteractionKit.) | |
IsPathSurrogateInMySubgraph(SoPath, SoPath, String, SoPath, Boolean) | (Inherited from SoInteractionKit.) | |
IsSynchronizable | Gets the ScaleViz synchronizable state of this object. | |
IsTrackerDirectMode | (Inherited from SoDragger.) | |
Pick | (Inherited from SoNode.) | |
RayPick | (Inherited from SoBaseKit.) | |
RegisterChildDragger | (Inherited from SoDragger.) | |
RegisterChildDraggerMovingIndependently | (Inherited from SoDragger.) | |
SaveStartParameters | (Inherited from SoDragger.) | |
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. | |
SetHandleEventAction | (Inherited from SoDragger.) | |
SetMinGesture(Int32) | Sets the number of pixels of movement required to initiate a constraint gesture. | |
SetMinGesture(Single) | Float version of OIV.Inventor.Draggers.SoDragger.SetMinGesture(System.Int32). | |
SetMotionMatrix | Set the motion matrix. | |
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. | |
SetPartAsDefault(String, SoNode) | Calls SetPartAsDefault(partName, newNode, true). (Inherited from SoInteractionKit.) | |
SetPartAsDefault(String, String) | Calls SetPartAsDefault(partName, newNodeName, true). (Inherited from SoInteractionKit.) | |
SetPartAsDefault(String, SoNode, Boolean) | (Inherited from SoInteractionKit.) | |
SetPartAsDefault(String, String, Boolean) | (Inherited from SoInteractionKit.) | |
SetPartAsPath | Sets any public part in the interaction kit as a "surrogate" path instead. | |
SetStartingPoint(SbVec3f) | (Inherited from SoDragger.) | |
SetStartingPoint(SoPickedPoint) | (Inherited from SoDragger.) | |
SetSynchronizable | Sets this to be a ScaleViz synchronizable object. | |
SetTempPathToThis | (Inherited from SoDragger.) | |
SetToDefaults | Sets all fields in this object to their default values. | |
SetTrackerDirectMode | Calls SetTrackerDirectMode(OIV.Inventor.Draggers.SoDragger.TrackerDirectModes( .SoDragger.DEFAULT )). (Inherited from SoDragger.) | |
SetTrackerDirectMode(SoDraggerTrackerDirectModes) | Sets the tracker direct mode for this dragger (see description above). | |
SetViewportRegion | Obsolete. (Inherited from SoDragger.) | |
SetViewVolume | Obsolete. (Inherited from SoDragger.) | |
ToString |
Converts this SoBase structure to a human readable string.
(Inherited from SoBase.) | |
Touch | Marks an instance as modified, simulating a change to it. | |
TransformMatrixLocalToWorld | (Inherited from SoDragger.) | |
TransformMatrixToLocalSpace | (Inherited from SoDragger.) | |
TransformMatrixWorldToLocal | (Inherited from SoDragger.) | |
UnregisterChildDragger | (Inherited from SoDragger.) | |
UnregisterChildDraggerMovingIndependently | (Inherited from SoDragger.) | |
WorkFieldsIntoTransform | (Inherited from SoDragger.) | |
Write | (Inherited from SoBaseKit.) |
Name | Description | |
---|---|---|
boundingBoxCaching | (Inherited from SoInteractionKit.) | |
boundingBoxIgnoring | Whether to ignore this node during bounding box traversal. | |
enableCallbacks | If set to false, motion, start and finish callbacks are disabled. | |
isActive | true when mouse is down and dragging, else false. | |
IsDisposable | ISafeDisposable interface implementation.
(Inherited from SoDisposable.) | |
pickCulling | Set pick caching mode. | |
renderCaching | Obsolete. Set render caching mode. | |
renderCulling | Set render culling mode. | |
rotation | Orientation of the rotating part (an arrow by default). | |
translation | Position of the origin of the directional light dragger. | |
UserData |
Gets or sets the user data to be contained by the field container.
(Inherited from SoFieldContainer.) |
Name | Description | |
---|---|---|
FinishDragging | (Inherited from SoDragger.) | |
MouseMove | (Inherited from SoDragger.) | |
StartDragging | (Inherited from SoDragger.) | |
ValueChanged | (Inherited from SoDragger.) |
OIV.Inventor.Draggers.SoDirectionalLightDragger is a composite dragger. It looks like a sun with a large arrow coming out of it. The arrow can be rotated about the sun by dragging with the mouse; its orientation is given by the OIV.Inventor.Draggers.SoDirectionalLightDragger.rotation field. You can also drag the sun (and the arrow with it) through 3-space. The location is stored in the OIV.Inventor.Draggers.SoDirectionalLightDragger.translation field.
The dragger uses an OIV.Inventor.Draggers.SoRotateSphericalDragger for changing the rotation. Instead of using the default spherical geometry, this dragger uses an arrow shape.
The sun is an OIV.Inventor.Draggers.SoDragPointDragger. Dragging it edits the OIV.Inventor.Draggers.SoDirectionalLightDragger.translation field; conversely, if you change the OIV.Inventor.Draggers.SoDirectionalLightDragger.translation field the sun will move to that new location, bringing the arrow with it. The sun looks and behaves just like the sun in an OIV.Inventor.Draggers.SoPointLightDragger, as does the material part. See the OIV.Inventor.Draggers.SoPointLightDragger reference page for details.
Remember: This is not a light source! It just looks like one. If you want to move a light with this dragger, you can either:
Use an OIV.Inventor.Manips.SoDirectionalLightManip, which is subclassed from OIV.Inventor.Nodes.SoLight. It creates an OIV.Inventor.Draggers.SoDirectionalLightDragger and uses it as the interface to change the direction of its light source (see the OIV.Inventor.Manips.SoDirectionalLightManip reference page). The manipulator also edits the material part of this dragger to match the color of light the manipulator is producing. However, the directional light manipulator will ignore the OIV.Inventor.Draggers.SoDirectionalLightDragger.translation field, because a directional light has no location or translation field. So in this case the translation dragger merely allows you to move the physical arrow to wherever you'd like it to be.
Put an OIV.Inventor.Nodes.SoTransform under an OIV.Inventor.Nodes.SoTransformSeparator. Add the OIV.Inventor.Nodes.SoDirectionalLight as the next child. Use a field-to-field connection between the OIV.Inventor.Draggers.SoDirectionalLightDragger.rotation fields of this dragger and the transform node to synchronize the light with this dragger.
Use engines to connect the OIV.Inventor.Draggers.SoDirectionalLightDragger.rotation field of this dragger to the direction field of an OIV.Inventor.Nodes.SoDirectionalLight. Use the OIV.Inventor.Draggers.SoDirectionalLightDragger.rotation as input to an OIV.Inventor.Engines.SoComposeMatrix engine. Then, use an OIV.Inventor.Engines.SoTransformVec3f engine to apply that matrix to (0,0,-1), the default light direction.
You can change the parts in any instance of this dragger using OIV.Inventor.Nodekits.SoBaseKit.SetPart(System.String, OIV.Inventor.Nodes.SoNode). The default part geometries are defined as resources for this OIV.Inventor.Draggers.SoDirectionalLightDragger class. They are detailed in the Dragger Resources section of the online reference page for this class. You can make your program use different default resources for the parts by copying the file $OIVHOME/data/draggerDefaults/directionalLightDragger.iv into your own directory, editing the file, and then setting the environment variable SO_DRAGGER_DIR to be a path to that directory.
See OIV.Inventor.Draggers.SoDragger for more information about using and customizing draggers, including code examples, using draggers in an immersive VR environment and using WYSIWYG draggers.
DirectionalLightDragger {
boundingBoxCaching | AUTO |
renderCulling | AUTO |
pickCulling | AUTO |
isActive | false |
translation | 0 0 0 |
rotation | 0 0 1 0 |
callbackList | NULL |
material | <directionalLightOverallMaterial resource> |
translatorRotInv | NULL |
translator | DragPointDragger { |
} | |
rotator | RotateSphericalDragger { |
} | |
rotator.rotator | <directionalLightRotatorRotator resource> |
rotator.rotatorActive | <directionalLightRotatorRotatorActive resource> |
rotator.feedback | <directionalLightRotatorFeedback resource> |
rotator.feedbackActive | <directionalLightRotatorFeedbackActive resource> |
translator.yzTranslator.translator | <directionalLightTranslatorPlaneTranslator resource> |
translator.xzTranslator.translator | <directionalLightTranslatorPlaneTranslator resource> |
translator.xyTranslator.translator | <directionalLightTranslatorPlaneTranslator resource> |
translator.yzTranslator.translatorActive | <directionalLightTranslatorPlaneTranslatorActive resource> |
translator.xzTranslator.translatorActive | <directionalLightTranslatorPlaneTranslatorActive resource> |
translator.xyTranslator.translatorActive | <directionalLightTranslatorPlaneTranslatorActive resource> |
translator.xTranslator.translator | <directionalLightTranslatorLineTranslator resource> |
translator.yTranslator.translator | <directionalLightTranslatorLineTranslator resource> |
translator.zTranslator.translator | <directionalLightTranslatorLineTranslator resource> |
translator.xTranslator.translatorActive | <directionalLightTranslatorLineTranslatorActive resource> |
translator.yTranslator.translatorActive | <directionalLightTranslatorLineTranslatorActive resource> |
translator.zTranslator.translatorActive | <directionalLightTranslatorLineTranslatorActive resource> |
Resource: | directionalLightRotatorRotator | |
Part: | rotator.rotator | |
Appearance: | white arrow that goes through the sun | |
Description: | picking this begins rotation of the arrow about the sun-shape | |
Resource: | directionalLightRotatorRotatorActive | |
Part: | rotator.rotatorActive | |
Appearance: | yellow arrow that goes through the sun | |
Description: | displayed while the arrow is being rotated | |
Resource: | directionalLightRotatorFeedback | |
Part: | rotator.feedback | |
Appearance: | empty Separator | |
Description: | this disables display of the axes that a rotateSpherical dragger uses by default | |
Resource: | directionalLightRotatorFeedbackActive | |
Part: | rotator.feedbackActive | |
Appearance: | empty Separator | |
Description: | this disables display of the axes that a rotateSpherical dragger uses by default | |
Resource: | directionalLightOverallMaterial | |
Part: | material | |
Appearance: | white. half strength emissive, half strength diffuse | |
Description: | sets material for the sun shape when stationary. Resource for the moving sun, directionalLightTranslatorPlaneTranslatorActive, contains a yellow material for highlighting. | |
Resource: | directionalLightTranslatorPlaneTranslator | |
Parts: | translator.yzTranslator.translator<BR> translator.xzTranslator.translator<BR> translator.xyTranslator.translator | |
Appearance: | sun shape with no material | |
Description: | picking these parts initiates dragging by the yz, xz, and xy planar draggers respectively. | |
Resource: | directionalLightTranslatorPlaneTranslatorActive | |
Parts: | translator.yzTranslator.translatorActive<BR> translator.xzTranslator.translatorActive<BR> translator.xyTranslator.translatorActive | |
Appearance: | yellow sun shape | |
Description: | shown during planar dragging in the yz, xz, and xy planes respectively. | |
Resource: | directionalLightTranslatorLineTranslator | |
Parts: | translator.xTranslator.translator<BR> translator.yTranslator.translator<BR> translator.zTranslator.translator | |
Appearance: | white cylinder | |
Description: | picking these parts initiates dragging in the x, y, and z linear draggers respectively. | |
Resource: | directionalLightTranslatorLineTranslatorActive | |
Parts: | translator.xTranslator.translatorActive<BR> translator.yTranslator.translatorActive<BR> translator.zTranslator.translatorActive | |
Appearance: | yellow cylinder | |
Description: | shown during linear dragging in the x, y, and z directions respectively. |
All Parts
Part Name | Part Type | Default Type | NULL Default |
callbackList | NodeKitListPart | yes | |
material | Material | yes | |
translatorRotInv | Rotation | yes | |
translator | DragPointDragger | yes | |
rotator | RotateSphericalDragger | yes |
Extra Information for List Parts from Above Table
Part Name | Container Type | Possible Types |
callbackList | Separator | Callback; EventCallback |