soui 5.0.0.1
Soui5 Doc
 
Loading...
Searching...
No Matches
SValueDescription Class Reference

Utility class to parse a string description of a size. More...

#include <SAnimation.h>

Public Member Functions

 SValueDescription (AniValueType _type=ABSOLUTE_VALUE, float _value=0.0f)
 Constructor for SValueDescription.
 

Static Public Member Functions

static SValueDescription parseValue (const SStringW &value)
 Parses a string description of a size. Size descriptions can appear in three forms:
 

Public Attributes

AniValueType type
 One of Animation.ABSOLUTE_VALUE, Animation.RELATIVE_TO_SELF, or Animation.RELATIVE_TO_PARENT.
 
SLayoutSize value
 The absolute or relative dimension for this Description.
 

Detailed Description

Utility class to parse a string description of a size.

Definition at line 24 of file SAnimation.h.

Constructor & Destructor Documentation

◆ SValueDescription()

SValueDescription::SValueDescription ( AniValueType _type = ABSOLUTE_VALUE,
float _value = 0.0f )
inline

Constructor for SValueDescription.

Parameters
_typeType of the value (ABSOLUTE_VALUE, RELATIVE_TO_SELF, RELATIVE_TO_PARENT)
_valueThe value to be described

Definition at line 31 of file SAnimation.h.

Member Function Documentation

◆ parseValue()

SNSBEGIN SValueDescription SValueDescription::parseValue ( const SStringW & value)
static

Parses a string description of a size. Size descriptions can appear in three forms:

  1. An absolute size. This is represented by a number.
  2. A size relative to the size of the object being animated. This is represented by a number followed by "%".
  3. A size relative to the size of the parent of the object being animated. This is represented by a number followed by "%p".
Parameters
valueThe typed value to parse
Returns
The parsed version of the description

Definition at line 8 of file SAnimation.cpp.

Member Data Documentation

◆ type

AniValueType SValueDescription::type

One of Animation.ABSOLUTE_VALUE, Animation.RELATIVE_TO_SELF, or Animation.RELATIVE_TO_PARENT.

Definition at line 40 of file SAnimation.h.

◆ value

SLayoutSize SValueDescription::value

The absolute or relative dimension for this Description.

Definition at line 45 of file SAnimation.h.


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