HOM/HOM_Vector2.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:
 *      Side Effects Software Inc
 *      123 Front Street West, Suite 1401
 *      Toronto, Ontario
 *      Canada   M5J 2M2
 *      416-504-9876
 *
 * COMMENTS:
 */

#ifndef __HOM_Vector2_h__
#define __HOM_Vector2_h__

#include "HOM_API.h"
#include "HOM_Defines.h"
#include "HOM_Errors.h"
#include "HOM_Module.h"
#include <UT/UT_Vector2.h>
#include <vector>
#include <stdexcept>

SWIGOUT(%rename(Vector2) HOM_Vector2;)

class HOM_API HOM_Vector2
{
public:
    HOM_Vector2() throw(HOM_Error)
    : myVector2(0.0f, 0.0f)
    { HOM_CONSTRUCT_OBJECT(this) }

    HOM_Vector2(float x, float y) throw(HOM_Error)
    : myVector2(x, y)
    { HOM_CONSTRUCT_OBJECT(this) }

    SWIGOUT(%ignore HOM_Vector2(const UT_Vector2&);)
    HOM_Vector2(const UT_Vector2 &vector2) throw(HOM_Error)
    : myVector2(vector2)
    { HOM_CONSTRUCT_OBJECT(this) }

    HOM_Vector2(const std::vector<float> &sequence)
        throw(HOM_InvalidSize, HOM_Error)
    {
        HOM_CONSTRUCT_OBJECT(this)
        setTo(sequence);
    }

    ~HOM_Vector2()
    { HOM_DESTRUCT_OBJECT(this) }

    bool operator==(HOM_Vector2 &vector2)
    { return myVector2 == vector2.myVector2; }

    bool operator!=(HOM_Vector2 &vector2)
    { return myVector2 != vector2.myVector2; }

    bool isAlmostEqual(HOM_Vector2 &vector2, float tolerance=0.00001);

    // This method is deprecated.
    bool almostEqual(HOM_Vector2 &vector2, float tolerance=0.00001)
    { return isAlmostEqual(vector2, tolerance); }

    int __hash__();
    std::string __str__();
    std::string __repr__();

    float __getitem__(int index) throw(std::out_of_range);
    void __setitem__(int index, float value) throw(std::out_of_range);
    int __len__()
    { return 2; }

    // operator[] exists only to make this class easier to use from C++,
    // and isn't wrapped by swig.
    SWIGOUT(%ignore operator[];)
    float &operator[](int index) throw(std::out_of_range);

    void setTo(const std::vector<float> &sequence) throw(HOM_InvalidSize);

    SWIGOUT(%ignore operator=;)
    HOM_Vector2 &operator=(const HOM_Vector2& vector2)
    {
        myVector2 = vector2.myVector2;
        return *this;
    }

    HOM_Vector2 __add__(HOM_Vector2 &vector2)
    { return HOM_Vector2(myVector2 + vector2.myVector2); }
    HOM_Vector2 __sub__(HOM_Vector2 &vector2)
    { return HOM_Vector2(myVector2 - vector2.myVector2); }
    HOM_Vector2 __neg__()
    { return HOM_Vector2(-myVector2); }
    HOM_Vector2 __mul__(float scalar)
    { return HOM_Vector2(myVector2 * scalar); }

    HOM_Vector2 normalized();
    float length()
    { return myVector2.length(); }
    float lengthSquared()
    { return myVector2.length2(); }

    float distanceTo(HOM_Vector2 &vector2);

    float dot(HOM_Vector2 &vector2)
    { return myVector2.dot(vector2.myVector2); }


    SWIGOUT(%ignore myVector2;)
    UT_Vector2 myVector2;
};

#endif

---