GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  SODIRECTIONALLIGHTDRAGGER (3)

NAME

SoDirectionalLightDragger — directional icon you rotate and translate by dragging with the mouse

CONTENTS

Inherits From
Synopsis
Description
Fields
Methods
Catalog Parts
Dragger Resources
File Format/defaults
See Also

INHERITS FROM

SoBase > SoFieldContainer > SoNode > SoBaseKit > SoInteractionKit > SoDragger > SoDirectionalLightDragger

SYNOPSIS

#include <Inventor/draggers/SoDirectionalLightDragger.h>

Fields from class SoDirectionalLightDragger:

    SoSFRotation    
                    
SoSFRotation         rotation    
SoSFVec3f    
                    
SoSFVec3f            translation

Fields from class SoDragger:

    SoSFBool    
                    
SoSFBool             isActive

Fields from class SoInteractionKit:

    SoSFEnum    
                    
SoSFEnum             renderCaching    
SoSFEnum    
                    
SoSFEnum             boundingBoxCaching    
SoSFEnum    
                    
SoSFEnum             renderCulling    
SoSFEnum    
                    
SoSFEnum             pickCulling

Parts from class SoBaseKit:

    (SoNodeKitListPart)    
                     
(SoNodeKitListPart)   callbackList

Methods from class SoDirectionalLightDragger:

       
                    
                     SoDirectionalLightDragger()    
static const SoNodekitCatalog *    
                    
static const SoNodekitCatalog * getClassNodekitCatalog() const    
static SoType    
                    
static SoType        getClassTypeId()

Methods from class SoDragger:

    void    
                    
void                 addStartCallback(SoDraggerCB *f, void *userData = NULL)    
void    
                    
void                 removeStartCallback(SoDraggerCB *f, void *userData = NULL)    
void    
                    
void                 addMotionCallback(SoDraggerCB *f, void *userData = NULL)    
void    
                    
void                 removeMotionCallback(SoDraggerCB *f, void *userData = NULL)    
void    
                    
void                 addFinishCallback(SoDraggerCB *f, void *userData = NULL)    
void    
                    
void                 removeFinishCallback(SoDraggerCB *f, void *userData = NULL)    
void    
                    
void                 addValueChangedCallback(SoDraggerCB *f, void *userData = NULL)    
void    
                    
void                 removeValueChangedCallback(SoDraggerCB *f, void *userData = NULL)    
SbBool    
                    
SbBool               enableValueChangedCallbacks()    
void    
                    
void                 setMinGesture(int pixels)    
int    
                    
int                  getMinGesture() const    
static void    
                    
static void          setMinScale(float newMinScale)    
static float    
                    
static float         getMinScale()

Methods from class SoInteractionKit:

    virtual SbBool    
                    
virtual SbBool       setPartAsPath(const SbName &partName, SoPath *surrogatePath )

Methods from class SoBaseKit:

    virtual const SoNodekitCatalog *    
                         
virtual const SoNodekitCatalog * getNodekitCatalog() const    
virtual SoNode *    
                         
virtual SoNode *          getPart(const SbName &partName, SbBool makeIfNeeded)    
SbString    
                         
SbString                  getPartString(const SoBase *part)    
virtual SoNodeKitPath *    
                         
virtual SoNodeKitPath *   createPathToPart(const SbName &partName, SbBool makeIfNeeded, const SoPath *pathToExtend = NULL)    
virtual SbBool    
                         
virtual SbBool            setPart(const SbName &partName, SoNode *newPart)    
SbBool    
                         
SbBool                    set(char *partName, char *parameters)    
SbBool    
                         
SbBool                    set(char *nameValuePairs)    
static SbBool    
                         
static SbBool             isSearchingChildren()    
static void    
                         
static void               setSearchingChildren(SbBool newVal)

Methods from class SoNode:

    void    
                    
void                 setOverride(SbBool state)    
SbBool    
                    
SbBool               isOverride() const    
SoNode *    
                    
SoNode *             copy(SbBool copyConnections = FALSE) const    
virtual SbBool    
                    
virtual SbBool       affectsState() const    
static SoNode *    
                    
static SoNode *      getByName(const SbName &name)    
static int    
                    
static int           getByName(const SbName &name, SoNodeList &list)

Methods from class SoFieldContainer:

    void    
                    
void                 setToDefaults()    
SbBool    
                    
SbBool               hasDefaultValues() const    
SbBool    
                    
SbBool               fieldsAreEqual(const SoFieldContainer *fc) const    
void    
                    
void                 copyFieldValues(const SoFieldContainer *fc, SbBool copyConnections = FALSE)    
void    
                    
void                 get(SbString &fieldDataString)    
virtual int    
                    
virtual int          getFields(SoFieldList &resultList) const    
virtual SoField *    
                    
virtual SoField *    getField(const SbName &fieldName) const    
SbBool    
                    
SbBool               getFieldName(const SoField *field, SbName &fieldName) const    
SbBool    
                    
SbBool               isNotifyEnabled() const    
SbBool    
                    
SbBool               enableNotify(SbBool flag)

Methods from class SoBase:

    void    
                    
void                 ref()    
void    
                    
void                 unref() const    
void    
                    
void                 unrefNoDelete() const    
void    
                    
void                 touch()    
virtual SoType    
                    
virtual SoType       getTypeId() const    
SbBool    
                    
SbBool               isOfType(SoType type) const    
virtual void    
                    
virtual void         setName(const SbName &name)    
virtual SbName    
                    
virtual SbName       getName() const

Macros from class SoBaseKit:

SO_GET_PART(kit, partName, partClass)
                    
SO_CHECK_PART(kit, partName, partClass)
                    

DESCRIPTION

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 rotation field. You can also drag the sun (and the arrow with it) through 3-space. The location is stored in the translation field.

The dragger uses an SoRotateSphericalDragger for changing the rotation. Instead of using the default spherical geometry, this dragger uses an arrow shape.

The sun is an SoDragPointDragger. Dragging it edits the translation field; conversely, if you change the 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 SoPointLightDragger, as does the material part. See the SoPointLightDragger man 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:

[a] Use an SoDirectionalLightManip, which is subclassed from SoLight. It creates an SoDirectionalLightDragger and uses it as the interface to change the direction of its light source (see the SoDirectionalLightManip man 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 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.

[b] Put an SoTransform under an SoTransformSeparator. Add the SoDirectionalLight as the next child. Use a field-to-field connection between the rotation fields of this dragger and the transform node to synchronize the light with this dragger.

[c] Use engines to connect the rotation field of this dragger to the direction field of an SoDirectionalLight. Use the rotation as input to an SoComposeMatrix engine. Then, use an 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 setPart(). The default part geometries are defined as resources for this 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 /usr/share/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.

FIELDS

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

    SoSFVec3f    
                    
SoSFVec3f            translation
Position of the origin of the directional light dragger.

METHODS

       
                    
                     SoDirectionalLightDragger()
Constructor.

    static const SoNodekitCatalog *    
                    
static const SoNodekitCatalog * getClassNodekitCatalog() const
Returns an SoNodekitCatalog for this class

    static SoType    
                    
static SoType        getClassTypeId()
Returns type identifier for this class.

CATALOG PARTS

All parts
   NULL by
Part NamePart TypeDefault TypeDefault
callbackListNodeKitListPart--yes
materialMaterial--yes
translatorRotInvRotation--yes
translatorDragPointDragger--yes
rotatorRotateSphericalDragger--yes

Extra information for list parts from above table
Part NameContainer TypePermissible Types 
callbackListSeparatorCallback, EventCallback

DRAGGER RESOURCES

.in 0n+.5i     Resource:         directionalLightRotatorRotator
.in 0n+.5i     Part:             rotator.rotator    
Appearance:       white arrow that goes through the sun    
Description:      picking this begins rotation of the arrow about the sun-shape

.in 0n+.5i     Resource:         directionalLightRotatorRotatorActive
.in 0n+.5i     Part:             rotator.rotatorActive    
Appearance:       yellow arrow that goes through the sun    
Description:      displayed while the arrow is being rotated

.in 0n+.5i     Resource:         directionalLightRotatorFeedback
.in 0n+.5i     Part:             rotator.feedback    
Appearance:       empty Separator    
Description:      this disables display of the axes that a rotateSpherical dragger uses by default

.in 0n+.5i     Resource:         directionalLightRotatorFeedbackActive
.in 0n+.5i     Part:             rotator.feedbackActive    
Appearance:       empty Separator    
Description:      this disables display of the axes that a rotateSpherical dragger uses by default

.in 0n+.5i     Resource:         directionalLightOverallMaterial
.in 0n+.5i     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.

.in 0n+.5i     Resource:         directionalLightTranslatorPlaneTranslator
.in 0n+.5i     Parts:            translator.yzTranslator.translator
                  translator.xzTranslator.translator
                  translator.xyTranslator.translator    
Appearance:       sun shape with no material    
Description:      picking these parts initiates dragging by the yz, xz, and xy planar draggers respectively.

.in 0n+.5i     Resource:         directionalLightTranslatorPlaneTranslatorActive
.in 0n+.5i     Parts:            translator.yzTranslator.translatorActive
                  translator.xzTranslator.translatorActive
                  translator.xyTranslator.translatorActive    
Appearance:       yellow sun shape    
Description:      shown during planar dragging in the yz, xz, and xy planes respectively.

.in 0n+.5i     Resource:         directionalLightTranslatorLineTranslator
.in 0n+.5i     Parts:            translator.xTranslator.translator
                  translator.yTranslator.translator
                  translator.zTranslator.translator    
Appearance:       white cylinder    
Description:      picking these parts initiates dragging in the x, y, and z linear draggers respectively.

.in 0n+.5i     Resource:         directionalLightTranslatorLineTranslatorActive
.in 0n+.5i     Parts:            translator.xTranslator.translatorActive
                  translator.yTranslator.translatorActive
                  translator.zTranslator.translatorActive    
Appearance:       yellow cylinder    
Description:      shown during linear dragging in the x, y, and z directions respectively.

FILE FORMAT/DEFAULTS

DirectionalLightDragger {



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

SEE ALSO

SoInteractionKit, SoDragger, SoCenterballDragger, SoDragPointDragger, SoHandleBoxDragger, SoJackDragger, SoPointLightDragger, SoRotateCylindricalDragger, SoRotateDiscDragger, SoRotateSphericalDragger, SoScale1Dragger, SoScale2Dragger, SoScale2UniformDragger, SoScaleUniformDragger, SoSpotLightDragger, SoTabBoxDragger, SoTabPlaneDragger, SoTrackballDragger, SoTransformBoxDragger, SoTransformerDragger, SoTranslate1Dragger, SoTranslate2Dragger

Search for    or go to Top of page |  Section 3 |  Main Index


SODIRECTIONALLIGHTDRAGGER(3IV) (-->)

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.