manganese_serialization_kit v0.2.4 Manganese.SerializationKit.Structs.UnityVector3

A Unity vector3 value with :x, :y, and :z components.

Note that Unity structs are available in order to process the data in the API server, but most vector calculations occur in the environment simulation service.

This module can be used as an Ecto type for de/serialization when interacting with the database.

Link to this section Summary

Types

t()

A Unity vector3.

Functions

Deserialize a vector3 from a map.

Deserialize a vector3 from a tuple.

Serialize a vector3 to a map.

Serialize a vector3 to a tuple.

The PostgreSQL composite type used to represent a vector3.

A vector3 with zero values for all components.

Link to this section Types

Link to this type

t()
t() :: %Manganese.SerializationKit.Structs.UnityVector3{
  x: float(),
  y: float(),
  z: float()
}

A Unity vector3.

Link to this type

t_external()
t_external() :: map()

Link to this type

t_internal()
t_internal() :: {float(), float(), float()}

Link to this section Functions

Link to this function

from_map(map)
from_map(t_external()) :: t()

Deserialize a vector3 from a map.

Link to this function

from_tuple(arg)
from_tuple(t_internal()) :: t()

Deserialize a vector3 from a tuple.

Link to this function

to_map(unity_vector3)
to_map(t()) :: t_external()

Serialize a vector3 to a map.

Link to this function

to_tuple(unity_vector3)
to_tuple(t()) :: t_internal()

Serialize a vector3 to a tuple.

Link to this function

type()
type() :: :unity_vector3

The PostgreSQL composite type used to represent a vector3.

Link to this function

zero()
zero() :: t()

A vector3 with zero values for all components.