LUA_API_Vector3.h

Go to the documentation of this file.

// |      _                   ____         __ _   
// |     / \  _   _ _ __ __ _/ ___|  ___  / _| |_ 
// |    / _ \| | | | '__/ _` \___ \ / _ \| |_| __|
// |   / ___ \ |_| | | | (_| |___) | (_) |  _| |_ 
// |  /_/   \_\__,_|_|  \__,_|____/ \___/|_|  \__|
// | 
// |  Aurasoft UK 2008 - 2016 http://www.aurasoft.co.uk
// | 
// |  Skyline Game Engine Lua API Documentation
// | 
// |    This file belongs to Aurasoft UK for the Skyline Game Engine of all versions.
// |    This file is not for use in any other software that is not owned by Aurasoft UK and cannot be used by any other 
// |    person outside of the Skyline Game Engine development team.
// |    
// | © Copyright - Aurasoft UK & Skyline Game Engine 2008 - 2016
// |

// SKYLINE LUA CLASS FOR API DOCUMENTATION

class vector3
{
public:

    float dotProduct( float vec1_X, float vec1_Y, float vec1_Z, float vec2_X, float vec2_Y, float vec2_Z );
    
    float absDotProduct( float vec1_X, float vec1_Y, float vec1_Z, float vec2_X, float vec2_Y, float vec2_Z );
    
    float angle( float vec1_X, float vec1_Y, float vec1_Z, float vec2_X, float vec2_Y, float vec2_Z );
    
    float3 crossProduct( float vec1_X, float vec1_Y, float vec1_Z, float vec2_X, float vec2_Y, float vec2_Z );
    
    int directionEquals( float vec1_X, float vec1_Y, float vec1_Z, float vec2_X, float vec2_Y, float vec2_Z, float tolerance );
    
    float distance( float vec1_X, float vec1_Y, float vec1_Z, float vec2_X, float vec2_Y, float vec2_Z );

    float4 getRotationTo( float vec1_X, float vec1_Y, float vec1_Z, float vec2_X, float vec2_Y, float vec2_Z, float fallbackVec_X, float fallbackVec_Y, float fallbackVec_Z );

    float3 midPoint( float vec1_X, float vec1_Y, float vec1_Z, float vec2_X, float vec2_Y, float vec2_Z );

    float normalise( float vec1_X, float vec1_Y, float vec1_Z );

    float3 normalisedCopy( float vec1_X, float vec1_Y, float vec1_Z );

    float length( float vec1_X, float vec1_Y, float vec1_Z );

    int isNAN( float vec1_X, float vec1_Y, float vec1_Z );

    int isZeroLength( float vec1_X, float vec1_Y, float vec1_Z );

    float3 perpendicular( float vec1_X, float vec1_Y, float vec1_Z );

    int positionCloses( float vec1_X, float vec1_Y, float vec1_Z, float vec2_X, float vec2_Y, float vec2_Z, float tolerance );

    int positionEquals( float vec1_X, float vec1_Y, float vec1_Z, float vec2_X, float vec2_Y, float vec2_Z, float tolerance );

    float3 primaryAxis( float vec1_X, float vec1_Y, float vec1_Z );

    float3 randomDeviant( float vec1_X, float vec1_Y, float vec1_Z, float randomAngle, float vec2_X, float vec2_Y, float vec2_Z );

    float3 reflect( float vec1_X, float vec1_Y, float vec1_Z, float vec2_X, float vec2_Y, float vec2_Z );

    float squaredDistance( float vec1_X, float vec1_Y, float vec1_Z, float vec2_X, float vec2_Y, float vec2_Z );
    
    float squaredLength( float vec1_X, float vec1_Y, float vec1_Z );

};