blender::math::Axis Class Reference

#include <BLI_math_basis_types.hh>

Public Types
enum class	Value : int8_t { X = 0 , Y , Z }

Public Member Functions
	Axis ()=default
constexpr	Axis (const Value axis)
constexpr	operator Value () const
constexpr int	as_int () const
	operator bool () const =delete

Static Public Member Functions
static constexpr Axis	from_char (char axis_char)
static constexpr Axis	from_int (const int axis_int)

Static Public Attributes
static constexpr Value	X = Value::X
static constexpr Value	Y = Value::Y
static constexpr Value	Z = Value::Z

Friends
std::ostream &	operator<< (std::ostream &stream, const Axis axis)

Detailed Description

An enum class representing one of the 3 basis axes. This is implemented using a class to allow operators and methods. NOTE: While this represents a 3D axis it can still be used to generate 2D basis vectors.

Definition at line 42 of file BLI_math_basis_types.hh.

Member Enumeration Documentation

Value

enum class blender::math::Axis::Value : int8_t

strong

Enumerator
X
Y
Z

Definition at line 44 of file BLI_math_basis_types.hh.

Constructor & Destructor Documentation

Axis() [1/2]

blender::math::Axis::Axis ( )

default

Axis() [2/2]

blender::math::Axis::Axis ( const Value axis )

inlineconstexpr

Definition at line 61 of file BLI_math_basis_types.hh.

Member Function Documentation

as_int()

int blender::math::Axis::as_int ( ) const

inlineconstexpr

Definition at line 85 of file BLI_math_basis_types.hh.

References int.

Referenced by blender::nodes::node_fn_axes_to_rotation_cc::AxesToRotationFunction::AxesToRotationFunction(), blender::nodes::node_fn_align_rotation_to_vector_cc::AlignRotationToVectorFunction::call(), blender::nodes::node_fn_axes_to_rotation_cc::AxesToRotationFunction::call(), blender::math::from_vector(), blender::math::tests::TEST(), and blender::math::transform_point().

from_char()

static constexpr Axis blender::math::Axis::from_char ( char axis_char )

inlinestaticconstexpr

Convert an uppercase axis character 'X', 'Y' or 'Z' to an enum value.

Definition at line 64 of file BLI_math_basis_types.hh.

References BLI_assert, X, and Z.

from_int()

static constexpr Axis blender::math::Axis::from_int ( const int axis_int )

inlinestaticconstexpr

Allow casting from DNA enums stored as short / int.

Definition at line 72 of file BLI_math_basis_types.hh.

References BLI_assert, X, and Z.

Referenced by blender::nodes::node_fn_axes_to_rotation_cc::AxesToRotationFunction::AxesToRotationFunction(), blender::math::AxisSigned::axis(), blender::nodes::node_fn_align_rotation_to_vector_cc::node_build_multi_function(), blender::nodes::node_fn_axes_to_rotation_cc::node_build_multi_function(), blender::math::tests::TEST(), blender::ed::view3d::geometry_nodes_gizmos::TransformGizmos::update_rotate_transform_and_target_property(), blender::ed::view3d::geometry_nodes_gizmos::TransformGizmos::update_scale_transform_and_target_property(), and blender::ed::view3d::geometry_nodes_gizmos::TransformGizmos::update_translate_transform_and_target_property().

operator bool()

blender::math::Axis::operator bool ( ) const

explicitdelete

Avoid hell.

operator Value()

blender::math::Axis::operator Value ( ) const

inlineconstexpr

Definition at line 80 of file BLI_math_basis_types.hh.

Friends And Related Symbol Documentation

operator<<

std::ostream & operator<< ( std::ostream & stream, const Axis axis )

friend

Definition at line 11 of file math_basis_types.cc.

Member Data Documentation

X

Value blender::math::Axis::X = Value::X

staticconstexpr

Definition at line 51 of file BLI_math_basis_types.hh.

Referenced by from_int(), blender::math::from_vector(), blender::math::invert(), blender::nodes::node_fn_axes_to_rotation_cc::node_init(), blender::nodes::node_fn_align_rotation_to_vector_cc::node_rna(), blender::nodes::node_fn_axes_to_rotation_cc::node_rna(), blender::math::orthogonalize(), blender::math::tests::TEST(), blender::tests::TEST(), and blender::tests::TEST().

Y

Value blender::math::Axis::Y = Value::Y

staticconstexpr

Definition at line 52 of file BLI_math_basis_types.hh.

Referenced by blender::math::from_vector(), blender::math::invert(), blender::nodes::node_fn_align_rotation_to_vector_cc::node_rna(), blender::nodes::node_fn_axes_to_rotation_cc::node_rna(), blender::math::orthogonalize(), blender::math::tests::TEST(), blender::tests::TEST(), blender::tests::TEST(), and blender::math::to_dual_quaternion().

Z

Value blender::math::Axis::Z = Value::Z

staticconstexpr

Definition at line 53 of file BLI_math_basis_types.hh.

Referenced by from_int(), blender::math::from_vector(), blender::math::invert(), blender::nodes::node_fn_align_rotation_to_vector_cc::node_init(), blender::nodes::node_fn_axes_to_rotation_cc::node_init(), blender::nodes::node_fn_align_rotation_to_vector_cc::node_rna(), blender::nodes::node_fn_axes_to_rotation_cc::node_rna(), blender::math::orthogonalize(), blender::math::tests::TEST(), blender::tests::TEST(), and blender::tests::TEST().

---

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

• BLI_math_basis_types.hh