HOM_ChannelGraph.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_ChannelGraph_h__
#define __HOM_ChannelGraph_h__

#include "HOM_API.h"
#include "HOM_BaseKeyframe.h"
#include "HOM_Defines.h"
#include "HOM_ChannelGraphSelection.h"
#include "HOM_ElemPtr.h"
#include "HOM_PaneTab.h"
#include "HOM_Parm.h"
#include "HOM_PtrOrNull.h"

#include <map>
#include <vector>


SWIGOUT(%rename(ChannelGraph) HOM_ChannelGraph;)

class HOM_API HOM_ChannelGraph
{
public:
    HOM_ChannelGraph()
    {
        HOM_CONSTRUCT_OBJECT(this)
    }
    HOM_ChannelGraph(const HOM_ChannelGraph &pane)
    { 
        // The only reason we need to explicitly define the copy constructor is
        // so we can call HOM_CONSTRUCT_OBJECT.  Otherwise, the compiler's
        // built-in version would be fine.
        HOM_CONSTRUCT_OBJECT(this)
    }
    virtual ~HOM_ChannelGraph()
    {
        HOM_DESTRUCT_OBJECT(this)
    }

    virtual bool operator==(HOM_PtrOrNull<HOM_ChannelGraph> graph) = 0;
    virtual bool operator!=(HOM_PtrOrNull<HOM_ChannelGraph> graph) = 0;

    virtual int __hash__() = 0;
    virtual std::string __repr__() = 0;

    virtual std::map<
                HOM_ElemPtr<HOM_Parm>,
                std::vector< HOM_ElemPtr<HOM_BaseKeyframe> >
            > selectedKeyframes() = 0;

    virtual std::vector< HOM_ElemPtr<HOM_ChannelGraphSelection> > selection() = 0;
    virtual void setSelection( const std::vector<HOM_ChannelGraphSelection*> & s) = 0;

    virtual HOM_EnumValue &selectionMode() = 0;
    virtual void setSelectionMode(HOM_EnumValue &mode) = 0;

    // Retime tool operations
    virtual std::vector<double> retimeMarkers() = 0;
    virtual HOM_OptionalIntInterval retimeMarkerSelection() = 0;
    virtual void setRetimeMarkerSelection(HOM_OptionalIntInterval range) = 0;

    virtual void insertRetimeMarker(double time) = 0;
    virtual void deleteRetimeMarker(int index) = 0;
    virtual void deleteRetimeMarkers(HOM_IntInterval range) = 0;
    virtual void deleteSelectedRetimeMarkers() = 0;
    virtual void clearRetimeMarkers() = 0;

    virtual void moveRetimeMarkers(HOM_IntInterval range, double delta, bool with_keys) = 0;
    virtual void moveSelectedRetimeMarkers(double delta, bool with_keys) = 0;
};

#endif // __HOM_ChannelGraph_h__