GR/GR_UserOption.h

Go to the documentation of this file.

/*
 * PROPRIETARY INFORMATION.  This software is proprietary to
 * Side Effects Software Inc., and is not to be reproduced,
 * transmitted, or disclosed in any way without written permission.
 *
 * Produced by:
 *      Ondrej Kos
 *      Side Effects Software Inc
 *      123 Front Street West, Suite 1401
 *      Toronto, Ontario
 *      Canada   M5J 2M2
 *      416-504-9876
 *
 * NAME:        GR_UserOption.h ( GR Library, C++)
 *
 * COMMENTS:
 *      A GR_UserOption is a custom display option which can be toggled on/off
 *      and contain any arbitrary settings.
 */

#ifndef __GR_UserOption__
#define __GR_UserOption__

#include "GR_API.h"

#include <UT/UT_String.h>
#include <UT/UT_VectorTypes.h>

class GR_OptionTemplate;
class GR_UserDecoration;
class GU_Detail;
class UT_Options;

class GR_API GR_UserOptionParm
{
public:
    const char  *myName;
    int          myType;
};

class GR_API GR_UserOption
{
public:
    GR_UserOption(const char *name, const char *label,
                  GR_OptionTemplate *entry);

    virtual     ~GR_UserOption();

    const char  *getName() const { return (const char *) myName; }
    void         setName(const char *name) { myName.harden(name); }
    const char  *getLabel() const { return (const char *) myLabel; }
    void         setLabel(const char *label) { myLabel.harden(label); }
    const char  *getIconName() const { return (const char *) myIconName; }
    void         setIconName(const char *name) { myIconName.harden(name); }

    GR_OptionTemplate   *getTemplate() const { return myTemplate; }

    // The version count is incremented whenever the settings of the
    // option are changed.
    int                  getVersion() const { return myVersion; }
    void                 bumpVersion() { myVersion++; }

    virtual GR_UserOption       *duplicate() const = 0;

    // Class I/O methods.  They return 0 if successful, -1 if not.
    virtual int                  saveCommand(ostream &os) const;
    virtual bool                 loadCommand(UT_IStream &is);

    virtual bool                 save(ostream &os, int indent) const;
    virtual bool                 load(UT_IStream &is);

    // Methods to manipulate the internal settings of the option.  The apply
    // method returns a boolean to indicate whether the settings have changed.
    virtual void                 querySettings(UT_Options &options) const = 0;
    virtual bool                 applySettings(const UT_Options &options) = 0;

    // Options for use with GR_RenderHook will generally return NULL.
    virtual GR_UserDecoration   *allocDecoration(const GU_Detail *) const
                                                { return 0; }
    virtual void                 freeDecoration(GR_UserDecoration *) const {}

    // A utility method to output settings as a single line where each 
    // setting is saved in the form:
    //     <token> ( <value1>, [<value2>...] ).
    // Return 0 if successful, -1 if not.
    // TODO: Take templates to specify order as UT_Options is sorted!
    static int                   saveSettings(ostream &os,
                                      const UT_Options &options, bool for_cmd);
                        
    // A utility method to extract settings from an input stream where each
    // settings is stored in the form:
    //     <token> ( <value1>, [<value2>...] )
    //
    // A terminal token can be specified to stop the processing of the stream
    // when it is encountered.
    static bool                  loadSettings(UT_IStream &is, 
                                      const GR_UserOptionParm *parm_templates,
                                      UT_Options &options, bool for_cmd,
                                      const char *terminal_token = 0);

protected:
    GR_UserOption(const GR_UserOption &src);

    virtual const GR_UserOptionParm     *getSettingTemplates() const  = 0;

    static void                  getDefaultColor(UT_Vector3 &clr);
    static void                  getDefaultSelColor(UT_Vector3 &clr);

    // Utility methods to query a specified setting.  The return value is used
    // to indicate the setting differs from the passed in value.
    static bool                  querySetting(const UT_Options &options,
                                              const char *name, bool &v);
    static bool                  querySetting(const UT_Options &options,
                                              const char *name, float &v);
    static bool                  querySetting(const UT_Options &options,
                                              const char *name, UT_String &v);
    static bool                  querySetting(const UT_Options &options,
                                              const char *name, UT_Vector3 &v);

private:
    UT_String                    myName;
    UT_String                    myLabel;
    UT_String                    myIconName;
    GR_OptionTemplate           *myTemplate;

    int                          myVersion;
};

#endif

---