CYILayoutConfig::CubeOffset Class Reference

Detailed Description

A class used to hold a 3D 'cube offset'.

The vStart vector defines an offset from the origin of an object, and the vEnd vector defines an offset at the 'tip' of an object. The values in vStart are equivalent to the left, top and front values respectively. The values in vEnd are equivalent to the right, bottom and back values respectively. CubeOffset objects can be used to represent a margin, padding or border size.

#include <layout/YiLayoutConfig.h>

Public Member Functions
	CubeOffset ()
	CubeOffset (float fOffset)
	CubeOffset (const glm::vec3 &vOffset)
glm::vec3	GetTotal () const
float	GetTotalX () const
float	GetTotalY () const
float	GetTotalZ () const
float	GetLeft () const
float	GetRight () const
float	GetTop () const
float	GetBottom () const
float	GetFront () const
float	GetBack () const

Static Public Member Functions
static CubeOffset	CreateFromPropertiesOf (const IYIPropertiesSource *pSource, const CYIString &keyPrefix, const CubeOffset &defaultValue=zeroInstance)

Public Attributes
glm::vec3	vStart
glm::vec3	vEnd

Static Public Attributes
static const CubeOffset	zeroInstance

Constructor & Destructor Documentation

CYILayoutConfig::CubeOffset::CubeOffset ( )

inline

CYILayoutConfig::CubeOffset::CubeOffset ( float  fOffset )

inline

CYILayoutConfig::CubeOffset::CubeOffset ( const glm::vec3 &  vOffset )

inline

Member Function Documentation

static CubeOffset CYILayoutConfig::CubeOffset::CreateFromPropertiesOf ( const IYIPropertiesSource *  pSource, const CYIString &  keyPrefix, const CubeOffset &  defaultValue = zeroInstance  )

static

float CYILayoutConfig::CubeOffset::GetBack ( ) const

inline

float CYILayoutConfig::CubeOffset::GetBottom ( ) const

inline

float CYILayoutConfig::CubeOffset::GetFront ( ) const

inline

float CYILayoutConfig::CubeOffset::GetLeft ( ) const

inline

float CYILayoutConfig::CubeOffset::GetRight ( ) const

inline

float CYILayoutConfig::CubeOffset::GetTop ( ) const

inline

glm::vec3 CYILayoutConfig::CubeOffset::GetTotal ( ) const

inline

float CYILayoutConfig::CubeOffset::GetTotalX ( ) const

inline

float CYILayoutConfig::CubeOffset::GetTotalY ( ) const

inline

float CYILayoutConfig::CubeOffset::GetTotalZ ( ) const

inline

Member Data Documentation

glm::vec3 CYILayoutConfig::CubeOffset::vEnd

glm::vec3 CYILayoutConfig::CubeOffset::vStart

const CubeOffset CYILayoutConfig::CubeOffset::zeroInstance

static

---

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

• layout/YiLayoutConfig.h