Movement::MoveSplineInitArgs Struct Reference

#include "MoveSplineInitArgs.h"

Public Member Functions
	MoveSplineInitArgs (std::size_t path_capacity=16)
bool	Validate (Unit *unit) const
	============================================================================================ More...

Public Attributes
PointsArray	path
FacingInfo	facing
MoveSplineFlag	flags
int32	path_Idx_offset {0}
float	velocity {0.f}
float	parabolic_amplitude {0.f}
float	time_perc {0.f}
uint32	splineId {0}
float	initialOrientation {0.f}
bool	HasVelocity {false}
bool	TransformForTransport {true}

Private Member Functions
bool	_checkPathBounds () const

Detailed Description

Constructor & Destructor Documentation

MoveSplineInitArgs()

Movement::MoveSplineInitArgs::MoveSplineInitArgs ( std::size_t  path_capacity = 16 )

inline

        {
            path.reserve(path_capacity);
        }

References path.

Member Function Documentation

_checkPathBounds()

bool Movement::MoveSplineInitArgs::_checkPathBounds ( ) const

private

    {
        if (!(flags & MoveSplineFlag::Mask_CatmullRom) && path.size() > 2)
        {
            constexpr auto MAX_OFFSET = (1 << 11) / 2;
            Vector3 middle = (path.front() + path.back()) / 2;
            Vector3 offset;
            for (uint32 i = 1; i < path.size() - 1; ++i)
            {
                offset = path[i] - middle;
                if (std::fabs(offset.x) >= MAX_OFFSET || std::fabs(offset.y) >= MAX_OFFSET || std::fabs(offset.z) >= MAX_OFFSET)
                {
                    LOG_ERROR("movement", "MoveSplineInitArgs::_checkPathBounds check failed");
                    return false;
                }
            }
        }
        return true;
    }

References flags, LOG_ERROR, Movement::MoveSplineFlag::Mask_CatmullRom, and path.

Validate()

bool Movement::MoveSplineInitArgs::Validate

(

Unit *

unit

)

const

============================================================================================

Returns true to show that the arguments were configured correctly and MoveSpline initialization will succeed.

    {
#define CHECK(exp) \
        if (!(exp)) \
        { \
            if (unit) \
                LOG_ERROR("misc.movesplineinitargs", "MoveSplineInitArgs::Validate: expression '{}' failed for {}", #exp, unit->GetGUID().ToString()); \
            else \
                LOG_ERROR("misc.movesplineinitargs", "MoveSplineInitArgs::Validate: expression '{}' failed for cyclic spline continuation", #exp); \
            return false;\
        }
        CHECK(path.size() > 1);
        CHECK(velocity > 0.01f);
        CHECK(time_perc >= 0.f && time_perc <= 1.f);
        //CHECK(_checkPathBounds());
        return true;
#undef CHECK
    }

References CHECK, path, time_perc, and velocity.

Referenced by Movement::MoveSplineInit::Launch().

Member Data Documentation

facing

FacingInfo Movement::MoveSplineInitArgs::facing

Referenced by Movement::MoveSpline::Initialize(), and Movement::MoveSplineInit::SetFacing().

flags

MoveSplineFlag Movement::MoveSplineInitArgs::flags

Referenced by _checkPathBounds(), Movement::MoveSpline::init_spline(), Movement::MoveSpline::Initialize(), Movement::MoveSplineInit::Launch(), Movement::MoveSplineInit::MoveSplineInit(), Movement::MoveSplineInit::SetAnimation(), Movement::MoveSplineInit::SetCyclic(), Movement::MoveSplineInit::SetFacing(), Movement::MoveSplineInit::SetFall(), Movement::MoveSplineInit::SetFly(), Movement::MoveSplineInit::SetOrientationFixed(), Movement::MoveSplineInit::SetOrientationInversed(), Movement::MoveSplineInit::SetParabolic(), Movement::MoveSplineInit::SetSmooth(), Movement::MoveSplineInit::SetTransportEnter(), Movement::MoveSplineInit::SetTransportExit(), Movement::MoveSplineInit::SetWalk(), and Movement::MoveSplineInit::Stop().

HasVelocity

bool Movement::MoveSplineInitArgs::HasVelocity {false}

Referenced by Movement::MoveSplineInit::Launch(), and Movement::MoveSplineInit::SetVelocity().

initialOrientation

float Movement::MoveSplineInitArgs::initialOrientation {0.f}

Referenced by Movement::MoveSpline::Initialize(), and Movement::MoveSplineInit::Launch().

parabolic_amplitude

float Movement::MoveSplineInitArgs::parabolic_amplitude {0.f}

Referenced by Movement::MoveSpline::Initialize(), and Movement::MoveSplineInit::SetParabolic().

path

PointsArray Movement::MoveSplineInitArgs::path

Referenced by _checkPathBounds(), Movement::MoveSpline::init_spline(), Movement::MoveSplineInit::Launch(), Movement::MoveSplineInit::MovebyPath(), MoveSplineInitArgs(), Movement::MoveSplineInit::MoveTo(), Movement::MoveSplineInit::Path(), and Validate().

path_Idx_offset

int32 Movement::MoveSplineInitArgs::path_Idx_offset {0}

Referenced by Movement::MoveSpline::Initialize(), Movement::MoveSplineInit::MovebyPath(), Movement::MoveSplineInit::MoveTo(), and Movement::MoveSplineInit::SetFirstPointId().

splineId

uint32 Movement::MoveSplineInitArgs::splineId {0}

Referenced by Movement::MoveSpline::Initialize(), Movement::MoveSplineInit::MoveSplineInit(), and Movement::MoveSplineInit::Stop().

time_perc

float Movement::MoveSplineInitArgs::time_perc {0.f}

Referenced by Movement::MoveSpline::Initialize(), Movement::MoveSplineInit::SetAnimation(), Movement::MoveSplineInit::SetParabolic(), and Validate().

TransformForTransport

bool Movement::MoveSplineInitArgs::TransformForTransport {true}

Referenced by Movement::MoveSplineInit::DisableTransportPathTransformations(), Movement::MoveSplineInit::MovebyPath(), Movement::MoveSplineInit::MoveSplineInit(), Movement::MoveSplineInit::MoveTo(), and Movement::MoveSplineInit::SetFacing().

velocity

float Movement::MoveSplineInitArgs::velocity {0.f}

Referenced by Movement::MoveSpline::init_spline(), Movement::MoveSplineInit::Launch(), Movement::MoveSplineInit::SetVelocity(), and Validate().