SoXtDirectionalLightEditor(3IV)

NAME
     SoXtDirectionalLightEditor (SoXtDirLtEd) - component for editing
     directional lights

INHERITS FROM
     SoXtComponent > SoXtDirectionalLightEditor

SYNOPSIS
     #include <Inventor_c/Xt/SoXtDirectionalLightEditor.h>

     typedef void        SoXtDirectionalLightEditorCB(void *userData, const
                              SoDirectionalLight *light)
     typedef SoXtDirectionalLightEditor
                         SoXtDirLtEd

          Functions from class SoXtDirectionalLightEditor:

     SoXtDirectionalLightEditor *
                                 SoXtDirLtEdCreate(Widget parent = NULL, const
                                      char *name = NULL, SbBool
                                      buildInsideParent = TRUE)
     void                        SoXtDirLtEdDelete(SoXtDirLtEd *this)
     void                        SoXtDirLtEdAttach(SoXtDirLtEd *this, SoPath
                                      *pathToLight)
     void                        SoXtDirLtEdDetach(SoXtDirLtEd *this)
     SbBool                      SoXtDirLtEdIsAttached(SoXtDirLtEd *this)
     void                        SoXtDirLtEdAddLtChangedCB(SoXtDirLtEd *this,
                                      SoXtDirectionalLightEditorCB *f, void
                                      *userData = NULL)
     void                        SoXtDirLtEdRemoveLtChangedCB(SoXtDirLtEd
                                      *this, SoXtDirectionalLightEditorCB *f,
                                      void *userData = NULL)
     void                        SoXtDirLtEdSetLt(SoXtDirLtEd *this, const
                                      SoDirectionalLight *newLight)
     const SoDirectionalLight *  SoXtDirLtEdGetLt(const SoXtDirLtEd *this)

          Functions from class SoXtComponent:

     void                SoXtDirLtEdShow(SoXtDirLtEd *this)
     void                SoXtDirLtEdHide(SoXtDirLtEd *this)
     SbBool              SoXtDirLtEdIsVisible(SoXtDirLtEd *this)
     Widget              SoXtDirLtEdGetWidget(const SoXtDirLtEd *this)
     SbBool              SoXtDirLtEdIsTopLevelShell(const SoXtDirLtEd *this)
     Widget              SoXtDirLtEdGetShellWidget(const SoXtDirLtEd *this)
     Widget              SoXtDirLtEdGetParentWidget(const SoXtDirLtEd *this)
     void                SoXtDirLtEdSetSize(SoXtDirLtEd *this, const SbVec2s
                              *size)
     SbVec2s             SoXtDirLtEdGetSize(SoXtDirLtEd *this)
     Display *           SoXtDirLtEdGetDisplay(SoXtDirLtEd *this)
     void                SoXtDirLtEdSetTitle(SoXtDirLtEd *this, const char
                              *newTitle)

     const char *        SoXtDirLtEdGetTitle(const SoXtDirLtEd *this)
     void                SoXtDirLtEdSetIconTitle(SoXtDirLtEd *this, const char
                              *newIconTitle)
     const char *        SoXtDirLtEdGetIconTitle(const SoXtDirLtEd *this)
     void                SoXtDirLtEdSetWinCloseCB(SoXtDirLtEd *this,
                              SoXtComponentCB *func, void *data = NULL)
     SoXtComponent *     SoXtDirLtEdGetComp(Widget w)
     const char *        SoXtDirLtEdGetWidgetName(const SoXtDirLtEd *this)
     const char *        SoXtDirLtEdGetClassName(const SoXtDirLtEd *this)


DESCRIPTION
     This class is used to edit an SoDirectionalLight node (color, intensity,
     and direction are changed). In addition to directly editing directional
     light nodes, the editor can also be used with callbacks which will be
     called whenever the light is changed. The component consists of a render
     area and a value slider in the main window, with controls to display a
     color picker. In the render area there appears a sphere representing the
     world, and a directional light manipulator representing the direction of
     the light. Picking on the manipulator and moving the mouse provides
     direct manipulation of the light direction. The color picker is used to
     edit the color, and the value slider edits the intensity.

     The editor can currently be attached to only one light at a time.
     Attaching to two different lights will automatically detach the first one
     before attaching the second.

FUNCTIONS
     SoXtDirectionalLightEditor *
                                 SoXtDirLtEdCreate(Widget parent = NULL, const
                                      char *name = NULL, SbBool
                                      buildInsideParent = TRUE)
     void                        SoXtDirLtEdDelete(SoXtDirLtEd *this)
          Constructor and destructor.

     void                        SoXtDirLtEdAttach(SoXtDirLtEd *this, SoPath
                                      *pathToLight)
     void                        SoXtDirLtEdDetach(SoXtDirLtEd *this)
          Attach/detach the editor to/from a directional light. When attached,
          changes made in the editor directly affect the attached light.

     SbBool                      SoXtDirLtEdIsAttached(SoXtDirLtEd *this)
          Returns TRUE if the editor is attached.

     void                        SoXtDirLtEdAddLtChangedCB(SoXtDirLtEd *this,
                                      SoXtDirectionalLightEditorCB *f, void
                                      *userData = NULL)
     void                        SoXtDirLtEdRemoveLtChangedCB(SoXtDirLtEd
                                      *this, SoXtDirectionalLightEditorCB *f,
                                      void *userData = NULL)
          Additional way of using the directional light editor, by registering
          a callback and setting the light.
     void                        SoXtDirLtEdSetLt(SoXtDirLtEd *this, const
                                      SoDirectionalLight *newLight)
     const SoDirectionalLight *  SoXtDirLtEdGetLt(const SoXtDirLtEd *this)
          Set new light values, and get the current light values.


SEE ALSO
     SoXtComponent, SoDirectionalLight