HOM_ChannelPrim.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_ChannelPrim_h__
#define __HOM_ChannelPrim_h__

#include "HOM_API.h"
#include "HOM_Defines.h"
#include "HOM_Errors.h"
#include "HOM_Prim.h"
#include "HOM_IterableList.h"
#include <vector>
#include <stdexcept>

SWIGOUT(%rename(ChannelPrim) HOM_ChannelPrim;)

class HOM_API HOM_ChannelPrim : virtual public HOM_Prim
{
public:
    HOM_ChannelPrim()
    { HOM_CONSTRUCT_OBJECT(this) }
    HOM_ChannelPrim(const HOM_ChannelPrim &face)
    : HOM_Prim(face)
    { HOM_CONSTRUCT_OBJECT(this) }
    ~HOM_ChannelPrim() override
    { HOM_DESTRUCT_OBJECT(this) }

    // TODO: Do we need to explicitly add operator== and operator!=, or
    //       does swig pick up the base class ones?

    // Let swig know we're overriding __repr__ for this class so it doesn't
    // provide its own __repr__.
    SWIGOUT(virtual std::string __repr__() = 0;)

    SWIGOUT(%newobject vertex;)
    virtual HOM_Vertex *vertex(int index) = 0;

    SWIGOUT(%newobject addVertex;)
    virtual HOM_Vertex *addVertex(HOM_Point &point) = 0;

    virtual double start() = 0;
    virtual double end() = 0;
    virtual double length() = 0;

    virtual void setStart(double frame) = 0;

    virtual double defaultValue() = 0;
    virtual void setDefaultValue(double value) = 0;

    SWIGOUT(%warnfilter(321) eval;)
    virtual double eval(double frame) = 0;
    virtual double _evalSlope(double frame) = 0;

    virtual bool hasKeyAtFrame(double frame) = 0;

    virtual void insertKey(double frame, bool auto_slope = true) = 0;
    virtual void destroyKey(double frame) = 0;
    virtual void destroyKeys(double frame_start, double frame_end) = 0;

    virtual void clear() = 0;

    /// Get the index of the key at the given frame. Returns -1 If there is no
    /// key at that frame.
    virtual int keyIndex(double frame) = 0;

    virtual bool setKeyValue(double frame, double value,
                             HOM_EnumValue *key_half=nullptr) = 0;
    virtual bool setKeySlope(double frame, double slope,
                             HOM_EnumValue *key_half=nullptr) = 0;
    virtual bool setKeyAccel(double frame, double accel,
                             HOM_EnumValue *key_half=nullptr) = 0;

    virtual double keyValue(double frame, HOM_EnumValue *key_half=nullptr) = 0;
    virtual double keySlope(double frame, HOM_EnumValue *key_half=nullptr) = 0;
    virtual double keyAccel(double frame, HOM_EnumValue *key_half=nullptr) = 0;

    virtual bool setKeyAutoSlope(double frame, bool auto_slope,
                                 HOM_EnumValue *key_half = nullptr) = 0;

    /// Get the type of the segment that starts at the given frame
    virtual HOM_EnumValue &segmentType(double frame) = 0;
    /// Set the type of the segment that starts at the given frame
    virtual void setSegmentType(double frame, HOM_EnumValue &type) = 0;

    virtual std::vector<double> keyFrames() = 0;
    virtual std::vector<double> keyValues(HOM_EnumValue *key_half=nullptr) = 0;
    virtual std::vector<double> keySlopes(HOM_EnumValue *key_half=nullptr) = 0;
    virtual std::vector<double> keyAccels(HOM_EnumValue *key_half=nullptr) = 0;

    virtual void setKeyValues(const std::vector<double> &values,
                              HOM_EnumValue *key_half = nullptr) = 0;
    virtual void setKeySlopes(const std::vector<double> &slopes,
                              HOM_EnumValue *key_half = nullptr) = 0;
    virtual void setKeyAccels(const std::vector<double> &accels,
                              HOM_EnumValue *key_half = nullptr) = 0;

    virtual void moveKeyframes(const std::vector<int> &key_indices,
                               const std::vector<double> &frame_offsets) = 0;

    virtual void smoothAutoSlopes(bool force = false) = 0;
    virtual void smoothAutoSlopesForKeys(int start_index,
                                         int end_index = -1,
                                         bool force = false) = 0;
};

#endif