You.i Engine
Public Member Functions | Protected Attributes | List of all members
CYIAnimatingLayoutConfig Class Reference
Layout

Detailed Description

A class used to hold per-child layout configuration for CYIAnimatingLayout layouts.

See also
CYIAnimatingLayout

#include <layout/YiAnimatingLayout.h>

Inheritance diagram for CYIAnimatingLayoutConfig:
Inheritance graph
[legend]

Public Member Functions

 CYIAnimatingLayoutConfig ()
 
virtual ~CYIAnimatingLayoutConfig ()
 
virtual void ConfigureFrom (const IYIPropertiesSource *pSource) override
 
void SetAnimatePosition (bool bAnimatePosition)
 Sets whether position layout animations should be applied to this node. More...
 
bool IsUsingAnimatedPosition () const
 
void SetAnimateSize (bool bAnimateSize)
 Sets whether size position animations should be applied to this node. More...
 
bool IsUsingAnimatedSize () const
 
- Public Member Functions inherited from CYILayoutConfig
 CYILayoutConfig ()
 
virtual ~CYILayoutConfig ()
 
void SetSizeConstraints (const SizeConstraints &sizeConstraints)
 
const SizeConstraints & GetSizeConstraints () const
 
void SetMargin (const Margin &margin)
 
const Margin & GetMargin () const
 
void SetLayoutable (bool bLayoutable)
 
bool IsLayoutable () const
 
void SetItemGravity (const glm::vec3 &vItemGravity)
 
void SetItemGravity (GRAVITY eItemGravity)
 
const glm::vec3 & GetItemGravity () const
 
void SetIsBackground (bool bBackground)
 
bool IsBackground () const
 
- Public Member Functions inherited from CYIScriptableRTTIObject
 CYIScriptableRTTIObject ()
 
virtual ~CYIScriptableRTTIObject ()
 
virtual const CYIRuntimeTypeInfo * GetRuntimeTypeInfoForScriptObject () const override
 
- Public Member Functions inherited from CYIScriptableObject
 CYIScriptableObject ()
 
 CYIScriptableObject (const CYIScriptableObject &other)
 
CYIScriptableObject & operator= (const CYIScriptableObject &other)
 
virtual ~CYIScriptableObject ()
 
CYIBindingImplementation * GetBindingImplementation () const
 
void SetBindingImplementation (CYIBindingImplementation *pBindingImplementation)
 

Protected Attributes

bool m_bAnimatePosition
 
bool m_bAnimateSize
 

Additional Inherited Members

- Public Types inherited from CYILayoutConfig
enum  GRAVITY {
  GRAVITY_NONE,
  GRAVITY_CENTER,
  GRAVITY_LEFT,
  GRAVITY_RIGHT,
  GRAVITY_TOP,
  GRAVITY_BOTTOM,
  GRAVITY_FRONT,
  GRAVITY_BACK,
  GRAVITY_TOP_LEFT,
  GRAVITY_TOP_RIGHT,
  GRAVITY_BOTTOM_LEFT,
  GRAVITY_BOTTOM_RIGHT
}
 
typedef CubeOffset Margin
 
- Static Public Member Functions inherited from CYILayoutConfig
static void RemoveSuffixFromNumber (CYIString &inOutNumber, CYIString &outSuffix)
 
static bool ParseBooleanValue (const CYIString &value)
 
static float ParseFloatValue (const CYIString &value)
 
static uint32_t ParseTimeValue (const CYIString &value)
 
static float ParseLengthValue (const CYIString &length)
 
static glm::vec3 ReadGravityFrom (const CYIString &key, const IYIPropertiesSource *pSource, const glm::vec3 &vDefault)
 
static glm::vec3 GetGravityVectorFor (GRAVITY eGravity)
 
- Protected Member Functions inherited from CYIScriptableRTTIObject
virtual std::pair< const CYIRuntimeTypeInfo *, const void * > GetRuntimeTypeInfoWithObject () const =0
 

Constructor & Destructor Documentation

CYIAnimatingLayoutConfig::CYIAnimatingLayoutConfig ( )
virtual CYIAnimatingLayoutConfig::~CYIAnimatingLayoutConfig ( )
virtual

Member Function Documentation

virtual void CYIAnimatingLayoutConfig::ConfigureFrom ( const IYIPropertiesSource *  pSource)
overridevirtual

Extracts configuration properties from properties source pSource (typically a scene node) and assigns them to this object.

Note
Subclasses should override this method. Remember to call the parent ConfigureFrom function.

Reimplemented from CYILayoutConfig.

Reimplemented in CYIGridLayoutConfig.

bool CYIAnimatingLayoutConfig::IsUsingAnimatedPosition ( ) const
inline
bool CYIAnimatingLayoutConfig::IsUsingAnimatedSize ( ) const
inline
void CYIAnimatingLayoutConfig::SetAnimatePosition ( bool  bAnimatePosition)

Sets whether position layout animations should be applied to this node.

Note
Setting to true has no effect if position animations are not enabled in the layout itself.
See also
CYIAnimatingLayout::SetMovingTime
void CYIAnimatingLayoutConfig::SetAnimateSize ( bool  bAnimateSize)

Sets whether size position animations should be applied to this node.

Note
Setting to true has no effect if size animations are not enabled in the layout itself.
See also
CYIAnimatingLayout::SetSizingTime

Member Data Documentation

bool CYIAnimatingLayoutConfig::m_bAnimatePosition
protected
bool CYIAnimatingLayoutConfig::m_bAnimateSize
protected
The documentation for this class was generated from the following file: