Click or drag to resize
SoDirectionalLightDragger Class

Directional icon you rotate and translate by dragging with the mouse.

Inheritance Hierarchy

Namespace: OIV.Inventor.Draggers
Assembly: OIV.Inventor (in OIV.Inventor.dll) Version: 10.12.3.0 (10.12.3.0)
Syntax
public class SoDirectionalLightDragger : SoDragger

The SoDirectionalLightDragger type exposes the following members.

Constructors
  NameDescription
Public methodSoDirectionalLightDragger

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 methodClearOtherEventCallbacks
(Inherited from SoDragger.)
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 methodCreatePathToThis
(Inherited from SoDragger.)
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 methodEnableValueChangedEvent

You can temporarily disable a dragger's valueChangedCallbacks.

(Inherited from SoDragger.)
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 methodGetEvent
(Inherited from SoDragger.)
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 methodGetHandleEventAction
(Inherited from SoDragger.)
Public methodGetHashCode
Overrides GetHashCode().
(Inherited from SoNetBase.)
Public methodGetLocalStartingPoint
(Inherited from SoDragger.)
Public methodGetLocalToWorldMatrix
Calls GetLocalToWorldMatrix((OIV.Inventor.Actions.SoAction ^)nullptr).
(Inherited from SoDragger.)
Public methodGetLocalToWorldMatrix(SoAction)
(Inherited from SoDragger.)
Public methodGetMatrix
(Inherited from SoBaseKit.)
Public methodGetMinGesture

Gets the number of pixels of movement required to initiate a constraint gesture.

(Inherited from SoDragger.)
Public methodGetMinGestureFloat (Inherited from SoDragger.)
Public methodGetMotionMatrix

Get the motion matrix.

(Inherited from SoDragger.)
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 methodGetPartToLocalMatrix
(Inherited from SoDragger.)
Public methodGetPickPath
(Inherited from SoDragger.)
Public methodGetPrimitiveCount
(Inherited from SoBaseKit.)
Public methodGetRenderEngineMode

Returns the supported Render engine mode.

(Inherited from SoNode.)
Public methodGetRenderUnitID
(Inherited from SoNode.)
Public methodGetStartMotionMatrix
(Inherited from SoDragger.)
Public methodGetStringName (Inherited from SoBase.)
Public methodGetSurrogatePartPickedName
(Inherited from SoDragger.)
Public methodGetSurrogatePartPickedOwner
(Inherited from SoDragger.)
Public methodGetSurrogatePartPickedPath
(Inherited from SoDragger.)
Public methodGetTrackerDirectMode

Get the current tracker direct mode for this dragger.

(Inherited from SoDragger.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetViewportIsEnabled (Inherited from SoBaseKit.)
Public methodGetViewportOrigin (Inherited from SoBaseKit.)
Public methodGetViewportRegion Obsolete.
(Inherited from SoDragger.)
Public methodGetViewportSize (Inherited from SoBaseKit.)
Public methodGetViewVolume Obsolete.

Dragger must not store information related to viewer settings.

(Inherited from SoDragger.)
Public methodGetWorldStartingPoint
(Inherited from SoDragger.)
Public methodGetWorldToLocalMatrix
Calls GetWorldToLocalMatrix((OIV.Inventor.Actions.SoAction ^)nullptr).
(Inherited from SoDragger.)
Public methodGetWorldToLocalMatrix(SoAction)
(Inherited from SoDragger.)
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 methodInvokeValueChanged

(Inherited from SoDragger.)
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 methodIsPathSurrogateInMySubgraph(SoPath)
(Inherited from SoInteractionKit.)
Public methodIsPathSurrogateInMySubgraph(SoPath, SoPath, String, SoPath)
Calls IsPathSurrogateInMySubgraph(pathToCheck, pathToOwner, surrogateNameInOwner, surrogatePathInOwner, true).
(Inherited from SoInteractionKit.)
Public methodIsPathSurrogateInMySubgraph(SoPath, SoPath, String, SoPath, Boolean)
(Inherited from SoInteractionKit.)
Public methodIsSynchronizable

Gets the ScaleViz synchronizable state of this object.

(Inherited from SoBase.)
Public methodIsTrackerDirectMode
(Inherited from SoDragger.)
Public methodPick
(Inherited from SoNode.)
Public methodRayPick
(Inherited from SoBaseKit.)
Public methodRegisterChildDragger
(Inherited from SoDragger.)
Public methodRegisterChildDraggerMovingIndependently
(Inherited from SoDragger.)
Public methodSaveStartParameters
(Inherited from SoDragger.)
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 methodSetHandleEventAction
(Inherited from SoDragger.)
Public methodSetMinGesture(Int32)

Sets the number of pixels of movement required to initiate a constraint gesture.

(Inherited from SoDragger.)
Public methodSetMinGesture(Single) (Inherited from SoDragger.)
Public methodSetMotionMatrix

Set the motion matrix.

(Inherited from SoDragger.)
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 methodSetPartAsDefault(String, SoNode)
Calls SetPartAsDefault(partName, newNode, true).
(Inherited from SoInteractionKit.)
Public methodSetPartAsDefault(String, String)
Calls SetPartAsDefault(partName, newNodeName, true).
(Inherited from SoInteractionKit.)
Public methodSetPartAsDefault(String, SoNode, Boolean)
(Inherited from SoInteractionKit.)
Public methodSetPartAsDefault(String, String, Boolean)
(Inherited from SoInteractionKit.)
Public methodSetPartAsPath

Sets any public part in the interaction kit as a "surrogate" path instead.

(Inherited from SoInteractionKit.)
Public methodSetStartingPoint(SbVec3f)
(Inherited from SoDragger.)
Public methodSetStartingPoint(SoPickedPoint)
(Inherited from SoDragger.)
Public methodSetSynchronizable

Sets this to be a ScaleViz synchronizable object.

(Inherited from SoBase.)
Public methodSetTempPathToThis
(Inherited from SoDragger.)
Public methodSetToDefaults

Sets all fields in this object to their default values.

(Inherited from SoFieldContainer.)
Public methodSetTrackerDirectMode
Calls SetTrackerDirectMode(OIV.Inventor.Draggers.SoDragger.TrackerDirectModes( .SoDragger.DEFAULT )).
(Inherited from SoDragger.)
Public methodSetTrackerDirectMode(SoDraggerTrackerDirectModes)

Sets the tracker direct mode for this dragger (see description above).

(Inherited from SoDragger.)
Public methodSetViewportRegion Obsolete.
(Inherited from SoDragger.)
Public methodSetViewVolume Obsolete.
(Inherited from SoDragger.)
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 methodTransformMatrixLocalToWorld
(Inherited from SoDragger.)
Public methodTransformMatrixToLocalSpace
(Inherited from SoDragger.)
Public methodTransformMatrixWorldToLocal
(Inherited from SoDragger.)
Public methodUnregisterChildDragger
(Inherited from SoDragger.)
Public methodUnregisterChildDraggerMovingIndependently
(Inherited from SoDragger.)
Public methodWorkFieldsIntoTransform
(Inherited from SoDragger.)
Public methodWrite
(Inherited from SoBaseKit.)
Top
Properties
  NameDescription
Public propertyboundingBoxCaching
(Inherited from SoInteractionKit.)
Public propertyboundingBoxIgnoring

Whether to ignore this node during bounding box traversal.

(Inherited from SoBaseKit.)
Public propertyenableCallbacks

If set to false, motion, start and finish callbacks are disabled.

(Inherited from SoDragger.)
Public propertyisActive

true when mouse is down and dragging, else false.

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

Set pick caching mode.

(Inherited from SoInteractionKit.)
Public propertyrenderCaching Obsolete.

Set render caching mode.

(Inherited from SoInteractionKit.)
Public propertyrenderCulling

Set render culling mode.

(Inherited from SoInteractionKit.)
Public propertyrotation

Orientation of the rotating part (an arrow by default).

Public propertytranslation

Position of the origin of the directional light dragger.

Public propertyUserData
Gets or sets the user data to be contained by the field container.
(Inherited from SoFieldContainer.)
Top
Events
  NameDescription
Public eventFinishDragging
(Inherited from SoDragger.)
Public eventMouseMove
(Inherited from SoDragger.)
Public eventStartDragging
(Inherited from SoDragger.)
Public eventValueChanged
(Inherited from SoDragger.)
Top
Remarks

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:

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.

FILE FORMAT/DEFAULT

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>
}

DRAGGER RESOURCES

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.

CATALOG PARTS

All Parts
Part NamePart TypeDefault TypeNULL 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 NameContainer TypePossible Types
callbackList Separator Callback; EventCallback

See Also