This page has been translated automatically.
UnigineEditor
Interface Overview
Assets Workflow
Settings and Preferences
Adjusting Node Parameters
Setting Up Materials
Setting Up Properties
Landscape Tool
Using Editor Tools for Specific Tasks
FAQ
Programming
Fundamentals
Setting Up Development Environment
Usage Examples
UnigineScript
C++
C#
UUSL (Unified UNIGINE Shader Language)
File Formats
Rebuilding the Engine and Tools
GUI
Double Precision Coordinates
API
Containers
Common Functionality
Controls-Related Classes
Engine-Related Classes
Filesystem Functionality
GUI-Related Classes
Node-Related Classes
Networking Functionality
Pathfinding-Related Classes
Physics-Related Classes
Plugins-Related Classes
CIGI Client Plugin
Rendering-Related Classes
Warning! This version of documentation is OUTDATED, as it describes an older SDK version! Please switch to the documentation for the latest SDK version.
Warning! This version of documentation describes an old SDK version which is no longer supported! Please upgrade to the latest SDK version.

Unigine.Unigine::vec3 Struct

This class represents a vector of 3 float components.

vec3 Class

Members


vec3()

Default constructor. Produces a zero vector.

vec3(const vec3 & v)

Constructor. Initializes the vector by copying a given source vector.

Arguments

  • const vec3 & v - Source vector.

vec3(const vec2 & v, float z)

Constructor. Initializes the vector using a given two-component vec2 source vector and a scalar.

Arguments

  • const vec2 & v - Two-component vector.
  • float z - Z component of the vector.

vec3(float x, float y, float z)

Constructor. Initializes the vector using given float values.

Arguments

  • float x - X component of the vector.
  • float y - Y component of the vector.
  • float z - Z component of the vector.

explicit vec3(float v)

Constructor. Initializes the vector using a given scalar value: x=v, y=v, z=v.

Arguments

  • float v - Scalar value.

Examples

Source code (UnigineScript)
vec3(1.0);
/*
Creates a vector (1.0, 1.0, 1.0)
*/

explicit vec3(const vec2 & v)

Constructor. Initializes the vector using a given vec2 source vector: x=v.x, y=v.y, z=0.0f.

Arguments

  • const vec2 & v - Two-component source vector.

explicit vec3(const vec4 & v)

Constructor. Initializes the vector using a given four-component vec4 source vector: x=v.x, y=v.y, z=v.z.

Arguments

  • const vec4 & v - Four-component source vector.

explicit vec3(const dvec3 & v)

Constructor. Initializes the vector using a given dvec3 source vector.

Arguments

  • const dvec3 & v - Source vector.

explicit vec3(const ivec3 & v)

Constructor. Initializes the vector using a given ivec3 source vector .

Arguments

  • const ivec3 & v - Source vector.

explicit vec3(const float * v)

Constructor. Initializes the vector using a given pointer to the array of float elements: x=v[0], y=v[1], z=v[2].

Arguments

  • const float * v - Pointer to the array of float elements.

void set(float x_, float y_, float z_)

Sets the vector by components.

Arguments

  • float x_ - X component of the vector.
  • float y_ - Y component of the vector.
  • float z_ - Z component of the vector.

void set(const float * val)

Sets the vector using the array of float elements: x=val[0], y=val[1], z=val[2].

Arguments

  • const float * val - Pointer to the array of float elements.

void get(float * val) const

Gets the vector: val[0]=x, val[1]=y, val[2]=z.

Arguments

  • float * val - Pointer to the array of float elements.

float * get()

Returns the pointer to the vector.

Return value

Pointer to the vector.

const float * get() const

Returns the constant pointer to the vector.

Return value

Pointer to the vector.

vec3 & operator*=(float val)

Performs scalar multiplication.

Arguments

  • float val - Scalar value.

Return value

Resulting vector.

vec3 & operator*=(const vec3 & val)

Performs vector multiplication.

Arguments

  • const vec3 & val - Vector.

Return value

Resulting vector.

vec3 & operator+=(const vec3 & val)

Performs vector addition.

Arguments

  • const vec3 & val - Vector.

Return value

Resulting vector.

vec3 operator-() const

Performs vector negation.

Return value

Resulting vector.

vec3 & operator-=(const vec3 & val)

Performs vector subtraction.

Arguments

  • const vec3 & val - Vector.

Return value

Resulting vector.

float & operator[](int i)

Performs array access to the vector item reference by using given item index.

Arguments

  • int i - Vector item index.

Return value

Vector item reference.

float operator[](int i) const

Performs array access to the vector item by using given item index.

Arguments

  • int i - Vector item index.

Return value

Vector item.

vec3 BACK

Description

Vector (0.0, 1.0, 0.0).

vec3 DOWN

Description

Vector (0.0, 0.0, -1.0).

vec3 EPS

Description

Vector, filled with epsilon constant (1e-6f).

vec3 FORWARD

Description

Vector (0.0, -1.0, 0.0).

vec3 INF

Description

Vector, filled with infinity constant (1e+9f).

vec3 LEFT

Description

Vector (1.0, 0.0, 0.0).

vec3 ONE

Description

Vector, filled with ones (1).

vec3 RIGHT

Description

Vector (-1.0, 0.0, 0.0).

vec3 UP

Description

Vector (0.0, 0.0, 1.0).

vec3 ZERO

Description

Vector, filled with zeros (0).
Last update: 2018-06-04
Build: ()