InputPromptStyle Class Reference

#include <InputPromptStyle.h>

Inheritance diagram for InputPromptStyle:

Public Member Functions
	DECLARE_ASSET (InputPromptStyle, Asset)
	InputPromptStyle ()
virtual	~InputPromptStyle ()
virtual void	LoadStream (Stream &stream, Platform platform) override
virtual void	SaveStream (Stream &stream, Platform platform) override
virtual void	Create () override
virtual void	Destroy () override
virtual void	GatherProperties (std::vector< Property > &outProps) override
virtual glm::vec4	GetTypeColor () override
virtual const char *	GetTypeName () override
float	GetIconSize () const
float	GetSpacing () const
glm::vec4	GetTint () const
InputPromptKind	GetPriorityAt (int32_t i) const
const std::array< InputPromptKind, kPriorityCount > &	GetPriority () const
void	SetPriorityAt (int32_t i, InputPromptKind kind)
const std::vector< std::string > &	GetPrewarmActions () const
std::vector< std::string > &	GetPrewarmActions ()
Public Member Functions inherited from Asset
	DECLARE_FACTORY_MANAGER (Asset)
	DECLARE_FACTORY (Asset, Asset)
	DECLARE_OBJECT (Asset, Object)
	Asset ()
virtual	~Asset ()
virtual void	Copy (Asset *srcAsset)
void	ResetLoadedFlag ()
const std::string &	GetName () const
bool	IsLoaded () const
bool	IsRefCounted () const
int32_t	GetRefCount () const
bool	IsEmbedded () const
void	SetEmbedded (bool embed)
bool	IsEngineAsset () const
void	SetEngineAsset (bool engineAsset)
void	SetName (const std::string &name)
void	IncrementRefCount ()
void	DecrementRefCount ()
void	LoadFile (const char *path, AsyncLoadRequest *request=nullptr)
void	LoadEmbedded (const EmbeddedFile *embeddedAsset, AsyncLoadRequest *request=nullptr)
void	SaveFile (const char *path, Platform platform)
virtual bool	Import (const std::string &path, ImportOptions *options=nullptr)
virtual const char *	GetTypeImportExt ()
virtual bool	ShouldSnapshotForPie () const
bool	IsTransient () const
void	SetTransient (bool transient)
uint64_t	GetUuid () const
void	SetUuid (uint64_t uuid)
void	EnsureUuid ()
void	WriteHeader (Stream &stream)
Public Member Functions inherited from Object
virtual	~Object ()=default
virtual const char *	RuntimeName () const =0
virtual const char *	RuntimeParentName () const =0
virtual RuntimeId	InstanceRuntimeId () const =0
virtual Object *	QueryInterface (RuntimeId id) const
virtual bool	Is (RuntimeId id) const
virtual bool	Is (const char *name) const
virtual bool	DrawCustomProperty (Property &prop)
template<typename T >
T *	As () const
virtual bool	Equals (const Object *rhs) const

Public Attributes
float	mIconSize = 24.0f
float	mSpacing = 2.0f
glm::vec4	mTint = glm::vec4(1.0f)
std::array< InputPromptKind, kPriorityCount >	mPriority
std::vector< std::string >	mPrewarmActions

Static Public Attributes
static constexpr int32_t	kPriorityCount = 3

Additional Inherited Members
Static Public Member Functions inherited from Asset
static AssetHeader	ReadHeader (Stream &stream)
static std::string	GetNameFromPath (const std::string &path)
static std::string	GetDirectoryFromPath (const std::string &path)
static const char *	GetNameFromTypeId (TypeId id)
static TypeId	GetTypeIdFromName (const char *name)
Static Public Member Functions inherited from Object
static const char *	ClassRuntimeName ()
Protected Attributes inherited from Asset
uint32_t	mVersion = 0
TypeId	mType = INVALID_TYPE_ID
uint64_t	mUuid = 0
bool	mEmbedded = false
bool	mLoaded = false
bool	mEnableRefCount = true
bool	mEngineAsset = false
bool	mTransient = false
std::string	mName = "Asset"
int32_t	mRefCount = 0

Constructor & Destructor Documentation

InputPromptStyle()

InputPromptStyle::InputPromptStyle

(

)

~InputPromptStyle()

InputPromptStyle::~InputPromptStyle ( )

virtual

Member Function Documentation

Create()

void InputPromptStyle::Create ( )

overridevirtual

Reimplemented from Asset.

DECLARE_ASSET()

InputPromptStyle::DECLARE_ASSET	(	InputPromptStyle	,
		Asset
	)

Destroy()

void InputPromptStyle::Destroy ( )

overridevirtual

Reimplemented from Asset.

GatherProperties()

void InputPromptStyle::GatherProperties ( std::vector< Property > &  outProps )

overridevirtual

Reimplemented from Asset.

GetIconSize()

float InputPromptStyle::GetIconSize ( ) const

inline

GetPrewarmActions() [1/2]

std::vector< std::string > & InputPromptStyle::GetPrewarmActions ( )

inline

GetPrewarmActions() [2/2]

const std::vector< std::string > & InputPromptStyle::GetPrewarmActions ( ) const

inline

GetPriority()

const std::array< InputPromptKind, kPriorityCount > & InputPromptStyle::GetPriority ( ) const

inline

GetPriorityAt()

InputPromptKind InputPromptStyle::GetPriorityAt

(

int32_t

i

)

const

GetSpacing()

float InputPromptStyle::GetSpacing ( ) const

inline

GetTint()

glm::vec4 InputPromptStyle::GetTint ( ) const

inline

GetTypeColor()

glm::vec4 InputPromptStyle::GetTypeColor ( )

overridevirtual

Reimplemented from Asset.

GetTypeName()

const char * InputPromptStyle::GetTypeName ( )

overridevirtual

Reimplemented from Asset.

LoadStream()

void InputPromptStyle::LoadStream ( Stream &  stream, Platform  platform  )

overridevirtual

Reimplemented from Asset.

SaveStream()

void InputPromptStyle::SaveStream ( Stream &  stream, Platform  platform  )

overridevirtual

Reimplemented from Asset.

SetPriorityAt()

void InputPromptStyle::SetPriorityAt	(	int32_t	i,
		InputPromptKind	kind
	)

Member Data Documentation

kPriorityCount

constexpr int32_t InputPromptStyle::kPriorityCount = 3

staticconstexpr

mIconSize

float InputPromptStyle::mIconSize = 24.0f

mPrewarmActions

std::vector<std::string> InputPromptStyle::mPrewarmActions

mPriority

std::array<InputPromptKind, kPriorityCount> InputPromptStyle::mPriority

Initial value:

= {
        InputPromptKind::Sprite,
        InputPromptKind::Glyph,
        InputPromptKind::Text,
    }

mSpacing

float InputPromptStyle::mSpacing = 2.0f

mTint

glm::vec4 InputPromptStyle::mTint = glm::vec4(1.0f)

---

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

• Engine/Source/Engine/Assets/InputPromptStyle.h
• Engine/Source/Engine/Assets/InputPromptStyle.cpp