soxtresource(3iv) [debian man page]

SoXtResource(3IV)()													       SoXtResource(3IV)()

NAME

       SoXtResource -- used to retrieve X resources for SoXtComponents and widgets

INHERITS FROM

       SoXtResource

SYNOPSIS

       #include <Inventor/Xt/SoXtResource.h>

	  Methods from class SoXtResource:

			 SoXtResource(Widget w)
			 ~SoXtResource()
     SbBool		 getResource(char *resName, char *resClass, SbColor &c)
     SbBool		 getResource(char *resName, char *resClass, short &i)
     SbBool		 getResource(char *resName, char *resClass, unsigned short &u)
     SbBool		 getResource(char *resName, char *resClass, char *&s)
     SbBool		 getResource(char *resName, char *resClass, SbBool &b)
     SbBool		 getResource(char *resName, char *resClass, float &f)

DESCRIPTION

       This class provides an easy to use interface for retrieving X resource values for widgets and components. Rather than use standard Xt calls
       to traverse up a widget hierarchy, this class performs its own traversal so that it may provide special care for widgets which are Inventor
       components. For instance, the Inventor Material Editor top level widget is a Motif form widget. Its class name is thus XmForm. SoXtResource
       knows that the editor is an Inventor component, though, so it uses the class name provided by the editor (in  this  case  "SoXtMaterialEdi-
       tor") when looking up resource values.

       EXAMPLE:
	  SoXtResource xr( materialEditor->getWidget() );
	  xr.getResource("tile1Color", "Tile1Color", color);
	  xr.getResource("updateFrequency", "UpdateFrequency", freq);

METHODS

			 SoXtResource(Widget w)
			 ~SoXtResource()
	  Constructor and destructor. The constructor takes the widget for which it will retrieve resource values.

     SbBool		 getResource(char *resName, char *resClass, SbColor &c)
     SbBool		 getResource(char *resName, char *resClass, short &i)
     SbBool		 getResource(char *resName, char *resClass, unsigned short &u)
     SbBool		 getResource(char *resName, char *resClass, char *&s)
     SbBool		 getResource(char *resName, char *resClass, SbBool &b)
     SbBool		 getResource(char *resName, char *resClass, float &f)
	  This	returns  the X resource value for the specified resource name and class. There is no need to specify the widget hierarchy; this is
	  automatically computed in the constructor.

NOTES

       Components will typically look up their own resources during buildWidget(). In order for a component to have its Inventor class name recog-
       nized  by  SoXtResource,  it  must call SoXtComponent::registerWidget() in its buildWidget() method. (This is done in every Inventor compo-
       nent.)

SEE ALSO

       X Resources (Xrm), X Intrinsics (Xt), SoXt, SoXtComponent

															       SoXtResource(3IV)()

SoXtMaterialEditor(3IV)()												 SoXtMaterialEditor(3IV)()

NAME

       SoXtMaterialEditor -- Component which lets you edit a material interactively

INHERITS FROM

       SoXtComponent > SoXtMaterialEditor

SYNOPSIS

       #include <Inventor/Xt/SoXtMaterialEditor.h>

     typedef void	 SoXtMaterialEditorCB(void *userData, const SoMaterial *mtl)

     enum UpdateFrequency {
	  SoXtMaterialEditor::CONTINUOUS
			      send updates with every mouse motion
	  SoXtMaterialEditor::AFTER_ACCEPT
			      only send updates after user hits accept button
     }

	  Methods from class SoXtMaterialEditor:

			 SoXtMaterialEditor(Widget parent = NULL, const char *name = NULL, SbBool buildInsideParent = TRUE)
			 ~SoXtMaterialEditor()
     void		 attach(SoMaterial *material, int index = 0)
     void		 detach()
     SbBool		 isAttached()
     void		 addMaterialChangedCallback(SoXtMaterialEditorCB *f, void *userData = NULL)
     void		 removeMaterialChangedCallback(SoXtMaterialEditorCB *f, void *userData = NULL)
     void		 setUpdateFrequency(SoXtMaterialEditor::UpdateFrequency freq)
     SoXtMaterialEditor::UpdateFrequency
			 getUpdateFrequency()
     void		 setMaterial(const SoMaterial &mtl)
     const SoMaterial &  getMaterial() const

	  Methods from class SoXtComponent:

     virtual void	     show()
     virtual void	     hide()
     SbBool		     isVisible()
     Widget		     getWidget() const
     SbBool		     isTopLevelShell() const
     Widget		     getShellWidget() const
     Widget		     getParentWidget() const
     void		     setSize(const SbVec2s &size)
     SbVec2s		     getSize()
     Display *		     getDisplay()
     void		     setTitle(const char *newTitle)
     const char *	     getTitle() const
     void		     setIconTitle(const char *newIconTitle)
     const char *	     getIconTitle() const
     void		     setWindowCloseCallback(SoXtComponentCB *func, void *data = NULL)
     static SoXtComponent *  getComponent(Widget w)
     const char *	     getWidgetName() const
     const char *	     getClassName() const

DESCRIPTION

       This  class  is used to edit the material properties of an SoMaterial node. The editor can also directly be used using callbacks instead of
       attaching it to a node. The component consists of a render area displaying a test sphere, some sliders, a set of radio buttons, and a menu.
       The  sphere  displays  the current material being edited. There is one slider for each material coefficient. Those fields are ambient, dif-
       fuse, specular, emissive (all of which are colors); and transparency and shininess (which are scalar values). A color editor can be  opened
       to edit the color slider base color. A material list displays palettes of predefined materials from which to choose.

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

METHODS

			 SoXtMaterialEditor(Widget parent = NULL, const char *name = NULL, SbBool buildInsideParent = TRUE)
			 ~SoXtMaterialEditor()
	  Constructor and destructor.

     void		 attach(SoMaterial *material, int index = 0)
     void		 detach()
	  Attach/detach the editor to a material node and edit the material of the given index.

     SbBool		 isAttached()
	  Returns TRUE if the editor is attached.

     void		 addMaterialChangedCallback(SoXtMaterialEditorCB *f, void *userData = NULL)
     void		 removeMaterialChangedCallback(SoXtMaterialEditorCB *f, void *userData = NULL)
	  Additional way of using the material editor, by registering a callback which will be called whenever the  material  changes  (check  the
	  UpdateFrequency to find when the callbacks will be called).

     void		 setUpdateFrequency(SoXtMaterialEditor::UpdateFrequency freq)
     SoXtMaterialEditor::UpdateFrequency
			 getUpdateFrequency()
	  Sets/gets the update frequency. See the UpdateFrequency enum declaration.

     void		 setMaterial(const SoMaterial &mtl)
     const SoMaterial &  getMaterial() const
	  Set a new material value, and get the current material value.

RESOURCES

	  *SoXtMaterialEditor.tile1Color: #4c4c4c (color name or hex value)
	  *SoXtMaterialEditor.tile2Color: #999999 (color name or hex value)
	  *SoXtMaterialEditor.light1Color: white (color name or hex value)
	  *SoXtMaterialEditor.light2Color: white (color name or hex value)
	  *SoXtMaterialEditor.updateFrequency: continuous (continuous | manual)

SEE ALSO

       SoXtComponent, SoXtMaterialList, SoXtDirLightEditor, SoMaterial

															 SoXtMaterialEditor(3IV)()