You.i Engine
CYILayoutConfig::CubeOffset Class Reference

Detailed Description

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

The start vector defines an offset from the origin of an object, and the end vector defines an offset at the 'tip' of an object. The values in start are equivalent to the left, top and front values respectively. The values in end 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 offset)
 
 CubeOffset (const glm::vec3 &offset)
 
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 start
 
glm::vec3 end
 

Static Public Attributes

static const CubeOffset zeroInstance
 

Constructor & Destructor Documentation

◆ CubeOffset() [1/3]

CYILayoutConfig::CubeOffset::CubeOffset ( )
inline

◆ CubeOffset() [2/3]

CYILayoutConfig::CubeOffset::CubeOffset ( float  offset)
inline

◆ CubeOffset() [3/3]

CYILayoutConfig::CubeOffset::CubeOffset ( const glm::vec3 &  offset)
inline

Member Function Documentation

◆ CreateFromPropertiesOf()

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

◆ GetBack()

float CYILayoutConfig::CubeOffset::GetBack ( ) const
inline

◆ GetBottom()

float CYILayoutConfig::CubeOffset::GetBottom ( ) const
inline

◆ GetFront()

float CYILayoutConfig::CubeOffset::GetFront ( ) const
inline

◆ GetLeft()

float CYILayoutConfig::CubeOffset::GetLeft ( ) const
inline

◆ GetRight()

float CYILayoutConfig::CubeOffset::GetRight ( ) const
inline

◆ GetTop()

float CYILayoutConfig::CubeOffset::GetTop ( ) const
inline

◆ GetTotal()

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

◆ GetTotalX()

float CYILayoutConfig::CubeOffset::GetTotalX ( ) const
inline

◆ GetTotalY()

float CYILayoutConfig::CubeOffset::GetTotalY ( ) const
inline

◆ GetTotalZ()

float CYILayoutConfig::CubeOffset::GetTotalZ ( ) const
inline

Member Data Documentation

◆ end

glm::vec3 CYILayoutConfig::CubeOffset::end

◆ start

glm::vec3 CYILayoutConfig::CubeOffset::start

◆ zeroInstance

const CubeOffset CYILayoutConfig::CubeOffset::zeroInstance
static

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