Skyline Lua API  Version 1.0 RC1
Lua Script Reference for Skyline Game Engine.
vector4 Class Reference

#include <LUA_API_Vector4.h>

Public Member Functions

float dotProduct (float vec1_W, float vec1_X, float vec1_Y, float vec1_Z, float vec2_W, float vec2_X, float vec2_Y, float vec2_Z)
 Calculates the dot (scalar) product of this vector with another. More...
 
int isNAN (float vec1_W, float vec1_X, float vec1_Y, float vec1_Z)
 Check whether this vector contains valid values. More...
 

Detailed Description

This area covers vector4 functions. Use as vector4.function(); This is a utility class that gives you access to many easy functions for vector mathmatics. For more information on how these functions can be used please visit the User Manual - http://www.chi-ad.com/Skyline/SDN/

all functions that take in vec1 are the primary vector to do an operation on.

Member Function Documentation

float vector4::dotProduct ( float  vec1_W,
float  vec1_X,
float  vec1_Y,
float  vec1_Z,
float  vec2_W,
float  vec2_X,
float  vec2_Y,
float  vec2_Z 
)

Calculates the dot (scalar) product of this vector with another.

Parameters
vec1_W: This is the W Axis of the vector which you are going to use an operation on.
vec1_X: This is the X Axis of the vector which you are going to use an operation on.
vec1_Y: This is the Y Axis of the vector which you are going to use an operation on.
vec1_Z: This is the Z Axis of the vector which you are going to use an operation on.
vec2_W: This is the W Axis of the vector which will be used for the operation.
vec2_X: This is the X Axis of the vector which will be used for the operation.
vec2_Y: This is the Y Axis of the vector which will be used for the operation.
vec2_Z: This is the Z Axis of the vector which will be used for the operation.
Returns
dotProduct : A float representing the dot product value.
int vector4::isNAN ( float  vec1_W,
float  vec1_X,
float  vec1_Y,
float  vec1_Z 
)

Check whether this vector contains valid values.

Parameters
vec1_W: This is the X Axis of the vector which you are going to use an operation on.
vec1_X: This is the Y Axis of the vector which you are going to use an operation on.
vec1_Y: This is the X Axis of the vector which you are going to use an operation on.
vec1_Z: This is the Y Axis of the vector which you are going to use an operation on.
Returns
state : A boolean represented by 1 or 0 for true or false.

The documentation for this class was generated from the following file: