Vec3ub.h

Go to the documentation of this file.

/*
* True Reality Open Source Game and Simulation Engine
* Copyright © 2021 Acid Rain Studios LLC
*
* This library is free software; you can redistribute it and/or modify it under
* the terms of the GNU Lesser General Public License as published by the Free
* Software Foundation; either version 3.0 of the License, or (at your option)
* any later version.
*
* This library is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
* details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this library; if not, write to the Free Software Foundation, Inc.,
* 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
* @author Maxim Serebrennik
*/
#pragma once

#include <trBase/Export.h>

#include <trUtil/StringUtils.h>
#include <trUtil/Math.h>

#include <osg/Vec3ub>

#include <iostream>
#include <string>

namespace trBase
{
    class TR_BASE_EXPORT Vec3ub
    {
    public:

        using value_type = unsigned char;

        const static int NUM_OF_COMPONENTS;

        Vec3ub();

        Vec3ub(value_type x, value_type y, value_type z);

        Vec3ub(const osg::Vec3ub &v);

        const osg::Vec3ub& GetOSGVector() const;

        value_type Length() const;

        value_type Length2() const;

        value_type Normalize();

        value_type& X();

        value_type& Y();

        value_type& Z();

        value_type X() const;

        value_type Y() const;

        value_type Z() const;

        value_type& R();

        value_type& G();

        value_type& B();

        value_type R() const;

        value_type G() const;

        value_type B() const;

        void Set(value_type x, value_type y, value_type z);

        void Set(const Vec3ub& v);

        void SetRGB(value_type r, value_type g, value_type b);

        void Lerp(const Vec3ub& to, value_type alpha);

        Vec3ub Lerp(const Vec3ub& from, const Vec3ub& to, value_type alpha);

        std::string ToString(int precision = -1);

        value_type* Ptr();

        const value_type* Ptr() const;

        value_type& operator [] (int i);

        value_type operator [] (int i) const;

        void operator = (const Vec3ub& v);

        void operator = (const osg::Vec3ub& v);

        bool operator == (const Vec3ub& v) const;

        bool operator != (const Vec3ub& v) const;

        bool operator <  (const Vec3ub& v) const;

        bool operator >  (const Vec3ub& v) const;

        value_type operator * (const Vec3ub& rhs) const;

        const Vec3ub operator * (value_type rhs) const;

        Vec3ub& operator *= (value_type rhs);

        const Vec3ub operator / (value_type rhs) const;

        Vec3ub& operator /= (value_type rhs);

        const Vec3ub operator + (const Vec3ub& rhs) const;

        Vec3ub& operator += (const Vec3ub& rhs);

        const Vec3ub operator - (const Vec3ub& rhs) const;

        Vec3ub& operator -= (const Vec3ub& rhs);

        const Vec3ub operator - () const;

        const Vec3ub operator ^ (const Vec3ub& rhs) const;

        operator osg::Vec3ub() const;

        operator osg::Vec3ub& ();

        operator const osg::Vec3ub& () const;

        operator osg::Vec3ub* ();

    protected:

        osg::Vec3ub mVec;
    };

    TR_BASE_EXPORT std::ostream& operator << (std::ostream& ios, const Vec3ub& vec);

    TR_BASE_EXPORT Vec3ub ComponentMultiply(const Vec3ub& lhs, const Vec3ub& rhs);

    TR_BASE_EXPORT Vec3ub ComponentDivide(const Vec3ub& lhs, const Vec3ub& rhs);
}