This page has been translated automatically.
Video Tutorials
Interface
Essentials
Advanced
How To
UnigineEditor
Interface Overview
Assets Workflow
Settings and Preferences
Working With Projects
Adjusting Node Parameters
Setting Up Materials
Setting Up Properties
Lighting
Landscape Tool
Sandworm (Experimental)
Using Editor Tools for Specific Tasks
Extending Editor Functionality
Built-in Node Types
Nodes
Objects
Effects
Decals
Light Sources
Geodetics
World Objects
Sound Objects
Pathfinding Objects
Players
Programming
Fundamentals
Setting Up Development Environment
Usage Examples
UnigineScript
C++
C#
UUSL (Unified UNIGINE Shader Language)
File Formats
Rebuilding the Engine Tools
GUI
Double Precision Coordinates
API
Containers
Common Functionality
Controls-Related Classes
Engine-Related Classes
Filesystem Functionality
GUI-Related Classes
Node-Related Classes
Objects-Related Classes
Networking Functionality
Pathfinding-Related Classes
Physics-Related Classes
Plugins-Related Classes
IG Plugin
CIGIConnector 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.vec2 Struct

This class represents a vector of 2 float components.

vec2 Class

Members


vec2 ( ) #

Default constructor. Produces a zero vector.

vec2 ( vec2 v ) #

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

Arguments

  • vec2 v - Source vector.

vec2 ( float x, float y ) #

Constructor. Initializes the vector using given float values.

Arguments

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

Examples

Source code (UnigineScript)
vec2(2.0, 3.0);
/*
Creates a vector (2.0, 3.0)
*/

explicit vec2 ( float v ) #

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

Arguments

  • float v - Scalar value.

Examples

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

explicit vec2 ( vec3 v ) #

Constructor. Initializes the vector using a given three-component vec3 source vector: x=v.x, y=v.y.

Arguments

  • vec3 v - Three-component source vector.

explicit vec2 ( vec4 v ) #

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

Arguments

  • vec4 v - Four-component source vector.

explicit vec2 ( dvec2 v ) #

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

Arguments

explicit vec2 ( ivec2 v ) #

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

Arguments

explicit vec2 ( float[] v ) #

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

Arguments

  • float[] v - Pointer to the array of float elements.

float Length ( ) #

Returns the length of the vector.

Return value

Vector length.

float Length2 ( ) #

Returns the squared length of the vector.

Return value

Squared length of the vector.

float Max ( ) #

Compares the vector components and returns the greater one.

Return value

The greater out of the two vector components.

vec2 Normalize ( ) #

Returns normalized vector.

Return value

Normalized vector.

vec2 Operator*= ( float val ) #

Performs scalar multiplication.

Arguments

  • float val - Scalar value.

Return value

Resulting vector.

vec2 Operator*= ( vec2 val ) #

Performs vector multiplication.

Arguments

  • vec2 val - Vector.

Return value

Resulting vector.

vec2 Operator+= ( vec2 val ) #

Performs vector addition.

Arguments

  • vec2 val - Vector.

Return value

Resulting vector.

vec2 Operator- ( ) #

Performs vector negation.

Return value

Resulting vector.

vec2 Operator-= ( vec2 val ) #

Performs vector subtraction.

Arguments

  • vec2 val - Vector.

Return value

Resulting vector.

vec2 operator= ( vec2 val ) #

Performs vector assignment. Destination vector = Source vector.

Arguments

  • vec2 val - Source vector.

Return value

Result.

float Operator[] ( int i ) #

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

Arguments

  • int i - Vector item index.

Return value

Vector item.
Last update: 2020-11-24
Build: ()