Ark Server API (ASA) - Wiki
Loading...
Searching...
No Matches
TScale< T > Class Template Reference

#include <TransformCalculus3D.h>

Public Types

using Vector3Type = UE::Math::TVector<T>
 

Public Member Functions

 TScale ()
 
 TScale (T InScale)
 
template<typename VType >
 TScale (const UE::Math::TVector< VType > &InScale)
 
const Vector3TypeGetVector () const
 
const TScale Concatenate (const TScale &RHS) const
 
const TScale Inverse () const
 

Private Attributes

Vector3Type Scale
 

Detailed Description

template<typename T>
class TScale< T >

Represents a 3D non-uniform scale (to disambiguate from an UE::Math::TVector<T>, which is used for translation).

Serves as a good base example of how to write a class that supports the basic transform calculus operations.

Definition at line 38 of file TransformCalculus3D.h.

Member Typedef Documentation

◆ Vector3Type

template<typename T >
using TScale< T >::Vector3Type = UE::Math::TVector<T>

Definition at line 43 of file TransformCalculus3D.h.

Constructor & Destructor Documentation

◆ TScale() [1/3]

template<typename T >
TScale< T >::TScale ( )
inline

Ctor. initialize to an identity scale, 1.0.

Definition at line 46 of file TransformCalculus3D.h.

◆ TScale() [2/3]

template<typename T >
TScale< T >::TScale ( T InScale)
inlineexplicit

Ctor. initialize from a uniform scale.

Definition at line 48 of file TransformCalculus3D.h.

◆ TScale() [3/3]

template<typename T >
template<typename VType >
TScale< T >::TScale ( const UE::Math::TVector< VType > & InScale)
inlineexplicit

Ctor. initialize from an UE::Math::TVector<T> defining the 3D scale.

Definition at line 51 of file TransformCalculus3D.h.

Member Function Documentation

◆ Concatenate()

template<typename T >
const TScale TScale< T >::Concatenate ( const TScale< T > & RHS) const
inline

Concatenate two scales.

Definition at line 55 of file TransformCalculus3D.h.

◆ GetVector()

template<typename T >
const Vector3Type & TScale< T >::GetVector ( ) const
inline

Access to the underlying UE::Math::TVector<T> that stores the scale.

Definition at line 53 of file TransformCalculus3D.h.

◆ Inverse()

template<typename T >
const TScale TScale< T >::Inverse ( ) const
inline

Invert the scale.

Definition at line 60 of file TransformCalculus3D.h.

Member Data Documentation

◆ Scale

template<typename T >
Vector3Type TScale< T >::Scale
private

Underlying storage of the 3D scale.

Definition at line 66 of file TransformCalculus3D.h.


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