sead
Loading...
Searching...
No Matches
agl::utl::ParameterBase Class Referenceabstract

#include <aglParameter.h>

Inherited by agl::utl::Parameter< sead::FixedSafeString< 32 > >, agl::utl::Parameter< sead::Vector3f >, agl::utl::Parameter< sead::Color4f >, agl::utl::Parameter< f32 >, agl::utl::Parameter< bool >, agl::utl::Parameter< s32 >, agl::utl::Parameter< sead::Vector4< f32 > >, agl::utl::Parameter< sead::Vector2< f32 > >, agl::utl::ParameterCurve< 1 >, agl::utl::ParameterCurve< 2 >, agl::utl::ParameterCurve< 3 >, agl::utl::ParameterCurve< 4 >, agl::utl::Parameter< T >, and agl::utl::ParameterCurve< N >.

Public Types

enum  ParameterType {
  cType_bool = 0 , cType_f32 = 1 , cType_int = 2 , cType_vec2 = 3 ,
  cType_vec3 = 4 , cType_vec4 = 5 , cType_color = 6 , cType_string32 = 7 ,
  cType_string64 = 8 , cType_curve1 = 9 , cType_curve2 = 10 , cType_curve3 = 11 ,
  cType_curve4 = 12
}

Public Member Functions

 ParameterBase ()
 ParameterBase (const sead::SafeString &name, const sead::SafeString &label, IParameterObj *p_obj)
 ParameterBase (const sead::SafeString &name, const sead::SafeString &label, const sead::SafeString &meta, IParameterObj *p_obj)
bool makeZero ()
void applyResource (ResParameter res)
void applyResource (ResParameter res, f32 t)
virtual bool copy (const ParameterBase &src)
virtual void copyUnsafe (const ParameterBase &src)
bool copyLerp (const ParameterBase &src_a, const ParameterBase &src_b, f32 t)
virtual void writeToXML (sead::XmlElement *, sead::Heap *) const
virtual s32 readFromXML (const sead::XmlElement &)
sead::SafeString getParameterName () const
sead::SafeString getLabel () const
sead::SafeString getMeta () const
virtual ParameterType getParameterType () const =0
virtual const void * ptr () const =0
virtual void * ptr ()=0
virtual const void * typePtr () const =0
virtual void * typePtr ()=0
virtual size_t size () const =0
virtual ParameterBase * clone (sead::Heap *heap, IParameterObj *p_obj) const =0
void initializeListNode (const sead::SafeString &name, const sead::SafeString &label, const sead::SafeString &meta, IParameterObj *p_obj)
u32 getNameHash () const

Static Public Member Functions

static u32 calcHash (const sead::SafeString &s)

Protected Member Functions

virtual void postApplyResource_ (const void *, size_t)

Protected Attributes

u32 mHash
sead::ListNode mListNode

Private Member Functions

template<typename T>
void copyLerp_ (const ParameterBase &src_a, const ParameterBase &src_b, f32 t)
template<>
void copyLerp_ (const ParameterBase &parameter_a, const ParameterBase &parameter_b, f32 t)

Friends

class IParameterObj

Member Enumeration Documentation

◆ ParameterType

enum agl::utl::ParameterBase::ParameterType
Enumerator
cType_bool 
cType_f32 
cType_int 
cType_vec2 
cType_vec3 
cType_vec4 
cType_color 
cType_string32 
cType_string64 
cType_curve1 
cType_curve2 
cType_curve3 
cType_curve4 

Constructor & Destructor Documentation

◆ ParameterBase() [1/3]

agl::utl::ParameterBase::ParameterBase ( )

◆ ParameterBase() [2/3]

agl::utl::ParameterBase::ParameterBase ( const sead::SafeString & name,
const sead::SafeString & label,
IParameterObj * p_obj )

◆ ParameterBase() [3/3]

agl::utl::ParameterBase::ParameterBase ( const sead::SafeString & name,
const sead::SafeString & label,
const sead::SafeString & meta,
IParameterObj * p_obj )

Member Function Documentation

◆ makeZero()

bool agl::utl::ParameterBase::makeZero ( )

◆ applyResource() [1/2]

void agl::utl::ParameterBase::applyResource ( ResParameter res)

◆ applyResource() [2/2]

void agl::utl::ParameterBase::applyResource ( ResParameter res,
f32 t )

◆ copy()

bool agl::utl::ParameterBase::copy ( const ParameterBase & src)
virtual

Reimplemented in agl::utl::ParameterCurve< N >, agl::utl::ParameterCurve< 1 >, agl::utl::ParameterCurve< 2 >, agl::utl::ParameterCurve< 3 >, and agl::utl::ParameterCurve< 4 >.

◆ copyUnsafe()

void agl::utl::ParameterBase::copyUnsafe ( const ParameterBase & src)
virtual

Reimplemented in agl::utl::ParameterCurve< N >, agl::utl::ParameterCurve< 1 >, agl::utl::ParameterCurve< 2 >, agl::utl::ParameterCurve< 3 >, and agl::utl::ParameterCurve< 4 >.

◆ copyLerp()

bool agl::utl::ParameterBase::copyLerp ( const ParameterBase & src_a,
const ParameterBase & src_b,
f32 t )

◆ copyLerp_() [1/2]

template<typename T>
void agl::utl::ParameterBase::copyLerp_ ( const ParameterBase & src_a,
const ParameterBase & src_b,
f32 t )
private

◆ writeToXML()

void agl::utl::ParameterBase::writeToXML ( sead::XmlElement * ,
sead::Heap *  ) const
virtual

◆ readFromXML()

s32 agl::utl::ParameterBase::readFromXML ( const sead::XmlElement & )
virtual

◆ getParameterName()

sead::SafeString agl::utl::ParameterBase::getParameterName ( ) const
inline

◆ getLabel()

sead::SafeString agl::utl::ParameterBase::getLabel ( ) const
inline

◆ getMeta()

sead::SafeString agl::utl::ParameterBase::getMeta ( ) const
inline

◆ getParameterType()

virtual ParameterType agl::utl::ParameterBase::getParameterType ( ) const
pure virtual

Implemented in agl::utl::Parameter< T >, agl::utl::Parameter< T >, agl::utl::Parameter< T >, agl::utl::Parameter< T >, agl::utl::Parameter< T >, agl::utl::Parameter< T >, agl::utl::Parameter< T >, agl::utl::Parameter< T >, agl::utl::Parameter< T >, agl::utl::Parameter< bool >, agl::utl::Parameter< bool >, agl::utl::Parameter< bool >, agl::utl::Parameter< bool >, agl::utl::Parameter< bool >, agl::utl::Parameter< bool >, agl::utl::Parameter< bool >, agl::utl::Parameter< bool >, agl::utl::Parameter< f32 >, agl::utl::Parameter< f32 >, agl::utl::Parameter< f32 >, agl::utl::Parameter< f32 >, agl::utl::Parameter< f32 >, agl::utl::Parameter< f32 >, agl::utl::Parameter< f32 >, agl::utl::Parameter< f32 >, agl::utl::Parameter< s32 >, agl::utl::Parameter< s32 >, agl::utl::Parameter< s32 >, agl::utl::Parameter< s32 >, agl::utl::Parameter< s32 >, agl::utl::Parameter< s32 >, agl::utl::Parameter< s32 >, agl::utl::Parameter< s32 >, agl::utl::Parameter< sead::Color4f >, agl::utl::Parameter< sead::Color4f >, agl::utl::Parameter< sead::Color4f >, agl::utl::Parameter< sead::Color4f >, agl::utl::Parameter< sead::Color4f >, agl::utl::Parameter< sead::Color4f >, agl::utl::Parameter< sead::Color4f >, agl::utl::Parameter< sead::Color4f >, agl::utl::Parameter< sead::FixedSafeString< 32 > >, agl::utl::Parameter< sead::FixedSafeString< 32 > >, agl::utl::Parameter< sead::FixedSafeString< 32 > >, agl::utl::Parameter< sead::FixedSafeString< 32 > >, agl::utl::Parameter< sead::FixedSafeString< 32 > >, agl::utl::Parameter< sead::FixedSafeString< 32 > >, agl::utl::Parameter< sead::FixedSafeString< 32 > >, agl::utl::Parameter< sead::FixedSafeString< 32 > >, agl::utl::Parameter< sead::Vector2< f32 > >, agl::utl::Parameter< sead::Vector2< f32 > >, agl::utl::Parameter< sead::Vector2< f32 > >, agl::utl::Parameter< sead::Vector2< f32 > >, agl::utl::Parameter< sead::Vector2< f32 > >, agl::utl::Parameter< sead::Vector2< f32 > >, agl::utl::Parameter< sead::Vector2< f32 > >, agl::utl::Parameter< sead::Vector2< f32 > >, agl::utl::Parameter< sead::Vector3f >, agl::utl::Parameter< sead::Vector3f >, agl::utl::Parameter< sead::Vector3f >, agl::utl::Parameter< sead::Vector3f >, agl::utl::Parameter< sead::Vector3f >, agl::utl::Parameter< sead::Vector3f >, agl::utl::Parameter< sead::Vector3f >, agl::utl::Parameter< sead::Vector3f >, agl::utl::Parameter< sead::Vector4< f32 > >, agl::utl::Parameter< sead::Vector4< f32 > >, agl::utl::Parameter< sead::Vector4< f32 > >, agl::utl::Parameter< sead::Vector4< f32 > >, agl::utl::Parameter< sead::Vector4< f32 > >, agl::utl::Parameter< sead::Vector4< f32 > >, agl::utl::Parameter< sead::Vector4< f32 > >, agl::utl::Parameter< sead::Vector4< f32 > >, agl::utl::ParameterCurve< N >, agl::utl::ParameterCurve< N >, agl::utl::ParameterCurve< N >, agl::utl::ParameterCurve< N >, agl::utl::ParameterCurve< N >, agl::utl::ParameterCurve< 1 >, agl::utl::ParameterCurve< 1 >, agl::utl::ParameterCurve< 1 >, agl::utl::ParameterCurve< 1 >, agl::utl::ParameterCurve< 1 >, agl::utl::ParameterCurve< 2 >, agl::utl::ParameterCurve< 2 >, agl::utl::ParameterCurve< 2 >, agl::utl::ParameterCurve< 2 >, agl::utl::ParameterCurve< 2 >, agl::utl::ParameterCurve< 3 >, agl::utl::ParameterCurve< 3 >, agl::utl::ParameterCurve< 3 >, agl::utl::ParameterCurve< 3 >, agl::utl::ParameterCurve< 3 >, agl::utl::ParameterCurve< 4 >, agl::utl::ParameterCurve< 4 >, agl::utl::ParameterCurve< 4 >, agl::utl::ParameterCurve< 4 >, and agl::utl::ParameterCurve< 4 >.

◆ ptr() [1/2]

virtual const void * agl::utl::ParameterBase::ptr ( ) const
pure virtual

Implemented in agl::utl::Parameter< T >, agl::utl::Parameter< T >, agl::utl::Parameter< bool >, agl::utl::Parameter< f32 >, agl::utl::Parameter< s32 >, agl::utl::Parameter< sead::Color4f >, agl::utl::Parameter< sead::FixedSafeString< 32 > >, agl::utl::Parameter< sead::Vector2< f32 > >, agl::utl::Parameter< sead::Vector3f >, agl::utl::Parameter< sead::Vector4< f32 > >, agl::utl::ParameterCurve< N >, agl::utl::ParameterCurve< 1 >, agl::utl::ParameterCurve< 2 >, agl::utl::ParameterCurve< 3 >, and agl::utl::ParameterCurve< 4 >.

◆ ptr() [2/2]

virtual void * agl::utl::ParameterBase::ptr ( )
pure virtual

Implemented in agl::utl::Parameter< T >, agl::utl::Parameter< T >, agl::utl::Parameter< bool >, agl::utl::Parameter< f32 >, agl::utl::Parameter< s32 >, agl::utl::Parameter< sead::Color4f >, agl::utl::Parameter< sead::FixedSafeString< 32 > >, agl::utl::Parameter< sead::Vector2< f32 > >, agl::utl::Parameter< sead::Vector3f >, agl::utl::Parameter< sead::Vector4< f32 > >, agl::utl::ParameterCurve< N >, agl::utl::ParameterCurve< 1 >, agl::utl::ParameterCurve< 2 >, agl::utl::ParameterCurve< 3 >, and agl::utl::ParameterCurve< 4 >.

◆ typePtr() [1/2]

virtual const void * agl::utl::ParameterBase::typePtr ( ) const
pure virtual

Implemented in agl::utl::Parameter< T >, agl::utl::Parameter< bool >, agl::utl::Parameter< f32 >, agl::utl::Parameter< s32 >, agl::utl::Parameter< sead::Color4f >, agl::utl::Parameter< sead::FixedSafeString< 32 > >, agl::utl::Parameter< sead::Vector2< f32 > >, agl::utl::Parameter< sead::Vector3f >, agl::utl::Parameter< sead::Vector4< f32 > >, agl::utl::ParameterCurve< N >, agl::utl::ParameterCurve< 1 >, agl::utl::ParameterCurve< 2 >, agl::utl::ParameterCurve< 3 >, and agl::utl::ParameterCurve< 4 >.

◆ typePtr() [2/2]

virtual void * agl::utl::ParameterBase::typePtr ( )
pure virtual

Implemented in agl::utl::Parameter< T >, agl::utl::ParameterCurve< N >, agl::utl::ParameterCurve< 1 >, agl::utl::ParameterCurve< 2 >, agl::utl::ParameterCurve< 3 >, and agl::utl::ParameterCurve< 4 >.

◆ size()

virtual size_t agl::utl::ParameterBase::size ( ) const
pure virtual

Implemented in agl::utl::Parameter< T >, agl::utl::Parameter< T >, agl::utl::Parameter< bool >, agl::utl::Parameter< f32 >, agl::utl::Parameter< s32 >, agl::utl::Parameter< sead::Color4f >, agl::utl::Parameter< sead::FixedSafeString< 32 > >, agl::utl::Parameter< sead::Vector2< f32 > >, agl::utl::Parameter< sead::Vector3f >, agl::utl::Parameter< sead::Vector4< f32 > >, agl::utl::ParameterCurve< N >, agl::utl::ParameterCurve< 1 >, agl::utl::ParameterCurve< 2 >, agl::utl::ParameterCurve< 3 >, and agl::utl::ParameterCurve< 4 >.

◆ clone()

virtual ParameterBase * agl::utl::ParameterBase::clone ( sead::Heap * heap,
IParameterObj * p_obj ) const
pure virtual

Implemented in agl::utl::Parameter< T >, agl::utl::Parameter< bool >, agl::utl::Parameter< f32 >, agl::utl::Parameter< s32 >, agl::utl::Parameter< sead::Color4f >, agl::utl::Parameter< sead::FixedSafeString< 32 > >, agl::utl::Parameter< sead::Vector2< f32 > >, agl::utl::Parameter< sead::Vector3f >, agl::utl::Parameter< sead::Vector4< f32 > >, agl::utl::ParameterCurve< N >, agl::utl::ParameterCurve< 1 >, agl::utl::ParameterCurve< 2 >, agl::utl::ParameterCurve< 3 >, and agl::utl::ParameterCurve< 4 >.

◆ postApplyResource_()

virtual void agl::utl::ParameterBase::postApplyResource_ ( const void * ,
size_t  )
inlineprotectedvirtual

Reimplemented in agl::utl::ParameterCurve< N >, agl::utl::ParameterCurve< 1 >, agl::utl::ParameterCurve< 2 >, agl::utl::ParameterCurve< 3 >, and agl::utl::ParameterCurve< 4 >.

◆ initializeListNode()

void agl::utl::ParameterBase::initializeListNode ( const sead::SafeString & name,
const sead::SafeString & label,
const sead::SafeString & meta,
IParameterObj * p_obj )

◆ getNameHash()

u32 agl::utl::ParameterBase::getNameHash ( ) const
inline

◆ calcHash()

u32 agl::utl::ParameterBase::calcHash ( const sead::SafeString & s)
static

◆ copyLerp_() [2/2]

template<>
void agl::utl::ParameterBase::copyLerp_ ( const ParameterBase & parameter_a,
const ParameterBase & parameter_b,
f32 t )
inlineprivate

◆ IParameterObj

friend class IParameterObj
friend

Member Data Documentation

◆ mHash

u32 agl::utl::ParameterBase::mHash
protected

◆ mListNode

sead::ListNode agl::utl::ParameterBase::mListNode
protected