HOM/HOM_Vector3.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_Vector3_h__
#define __HOM_Vector3_h__

#include "HOM_API.h"
#include "HOM_Defines.h"
#include "HOM_Errors.h"
#include "HOM_Module.h"
#include <UT/UT_Vector3.h>
#include <vector>
#include <stdexcept>
class HOM_Matrix4;
class HOM_Vector4;
class HOM_Matrix3;

SWIGOUT(%rename(Vector3) HOM_Vector3;)

class HOM_API HOM_Vector3
{
public:
    HOM_Vector3() throw(HOM_Error)
    : myVector3(0.0f, 0.0f, 0.0f)
    { HOM_CONSTRUCT_OBJECT(this) }

    HOM_Vector3(float x, float y, float z) throw(HOM_Error)
    : myVector3(x, y, z)
    { HOM_CONSTRUCT_OBJECT(this) }

    SWIGOUT(%ignore HOM_Vector3(const UT_Vector3&);)
    HOM_Vector3(const UT_Vector3 &vector3) throw(HOM_Error)
    : myVector3(vector3)
    { HOM_CONSTRUCT_OBJECT(this) }

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

    HOM_Vector3(HOM_Vector4 &vector4) throw(HOM_Error);

    ~HOM_Vector3()
    { HOM_DESTRUCT_OBJECT(this) }

    bool operator==(HOM_Vector3 &vector3)
    { return myVector3 == vector3.myVector3; }

    bool operator!=(HOM_Vector3 &vector3)
    { return myVector3 != vector3.myVector3; }

    bool isAlmostEqual(HOM_Vector3 &vector3, float tolerance=0.00001);

    // This method is deprecated.
    bool almostEqual(HOM_Vector3 &vector3, float tolerance=0.00001)
    { return isAlmostEqual(vector3, 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 3; }

    // 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_Vector3 &operator=(const HOM_Vector3& vector3)
    {
        myVector3 = vector3.myVector3;
        return *this;
    }

    HOM_Vector3 __add__(HOM_Vector3 &vector3)
    { return HOM_Vector3(myVector3 + vector3.myVector3); }
    HOM_Vector3 __sub__(HOM_Vector3 &vector3)
    { return HOM_Vector3(myVector3 - vector3.myVector3); }
    HOM_Vector3 __neg__()
    { return HOM_Vector3(-myVector3); }
    HOM_Vector3 __mul__(float scalar)
    { return HOM_Vector3(myVector3 * scalar); }
    HOM_Vector3 __rmul__(float scalar)
    { return HOM_Vector3(myVector3 * scalar); }
    HOM_Vector3 __mul__(HOM_Matrix4 &matrix4);

    HOM_Vector3 normalized();
    float length()
    { return myVector3.length(); }
    float lengthSquared()
    { return myVector3.length2(); }


    SWIGOUT(%newobject matrixToRotateTo;)
    HOM_Matrix4 *matrixToRotateTo(HOM_Vector3 &vector3);


    float distanceTo(HOM_Vector3 &vector3);
    float angleTo(HOM_Vector3 &vector3);

    float dot(HOM_Vector3 &vector3)
    { return myVector3.dot(vector3.myVector3); }
    HOM_Vector3 cross(HOM_Vector3 &vector3)
    { return ::cross(myVector3, vector3.myVector3); }


    SWIGOUT(%ignore myVector3;)
    UT_Vector3 myVector3;
};

#endif

---