HOM_AnimBar.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.
 *
 * COMMENTS:
 */

#ifndef __HOM_AnimBar_h__
#define __HOM_AnimBar_h__

#include "HOM_API.h"
#include "HOM_Defines.h"
#include "HOM_Errors.h"
#include "HOM_IterableList.h"

#include <stdexcept>

class SI_AnimBar;

SWIGOUT(%rename(AnimBar) HOM_AnimBar;)

class HOM_API HOM_AnimBar
{
public:
    HOM_AnimBar()
    { HOM_CONSTRUCT_OBJECT(this) }
    HOM_AnimBar(const HOM_AnimBar &)
    { HOM_CONSTRUCT_OBJECT(this) }
    virtual ~HOM_AnimBar()
    { HOM_DESTRUCT_OBJECT(this) }

    virtual std::string __repr__() = 0; // NOLINT

    // Return the list of active tools
    virtual std::vector<std::string> tools(bool shown_only = true) = 0;
    virtual std::vector<std::string> hiddenTools() = 0;
    virtual void setTools(const std::vector<std::string> &tool_ids) = 0;

    virtual void removeTool(const std::string &id) = 0;
    virtual void addTool(const std::string &id, int index = -1) = 0;

    // Reset the toolbar to its original state
    virtual void reset() = 0;

    // Turn the labels on or off. If off, abbreviated text labels will be
    // placed on the slider handles instead.
    virtual void showLabels(bool show) = 0;
    virtual bool labelsShown() = 0;

    // Get or set the tool size
    virtual void setToolSize(HOM_EnumValue &tool_size) = 0;
    virtual HOM_EnumValue &toolSize() = 0;

private:

};

#endif