Description

A text box class with BMG message support.

Definition at line 6 of file d_lyttextBox.hpp.

Public Member Functions
void	setMessage (MsgRes_c *bmg, ulong messageGroup, ulong messageID, long placeholderCount,...)
	Sets the message to display in the text box.

void	setText (const wchar_t *text, long placeholderCount,...)
	Sets the text to display in the text box.

void	ExtensionUserDataSetup ()
	Checks for extension user data in the layout.

Public Member Functions inherited from nw4r::lyt::TextBox
	NW4R_UT_RTTI_DECL (TextBox)

	TextBox (const res::TextBox *pRes, const ResBlockSet &rBlockSet)

virtual void	DrawSelf (const DrawInfo &rInfo)

virtual ut::Color	GetVtxColor (ulong idx) const

virtual void	SetVtxColor (ulong idx, ut::Color color)

virtual u8	GetVtxColorElement (ulong idx) const

virtual void	SetVtxColorElement (ulong idx, u8 value)

virtual void	AllocStringBuffer (u16 len)

virtual void	FreeStringBuffer ()

u16	GetStringBufferLength () const

virtual u16	SetString (const wchar_t *pStr, u16 pos)

virtual u16	SetString (const wchar_t *pStr, u16 pos, u16 len)

ut::Rect	GetTextDrawRect (const DrawInfo &rInfo) const

ut::Rect	GetTextDrawRect (ut::WideTextWriter *pWriter) const

const wchar_t *	GetString () const

const wchar_t *	GetStringBuffer () const

const ut::Font *	GetFont () const

void	SetFont (const ut::Font *pFont)

ut::Color	GetTextColor (ulong idx) const

void	SetTextColor (ulong idx, ut::Color color)

const Size &	GetFontSize () const

void	SetFontSize (const Size &rFontSize)

f32	GetLineSpace () const

void	SetLineSpace (f32 space)

f32	GetCharSpace () const

void	SetCharSpace (f32 space)

ut::WideTagProcessor *	GetTagProcessor () const

void	SetTagProcessor (ut::WideTagProcessor *pProcessor)

u8	GetTextPositionH () const

void	SetTextPositionH (u8 value)

u8	GetTextPositionV () const

void	SetTextPositionV (u8 value)

f32	GetTextMagH () const

f32	GetTextMagV () const

ulong	MakeDrawFlag () const

Public Member Functions inherited from nw4r::lyt::Pane
	NW4R_UT_RTTI_DECL (Pane)

	Pane (const res::Pane *pRes)

virtual void	CalculateMtx (const DrawInfo &rInfo)

void	CalculateMtxChild (const DrawInfo &rInfo)

virtual void	Draw (const DrawInfo &rInfo)

virtual void	Animate (ulong option)

virtual void	AnimateSelf (ulong option)

virtual u8	GetColorElement (ulong idx) const

virtual void	SetColorElement (ulong idx, u8 value)

virtual Pane *	FindPaneByName (const char *pName, bool recursive)

virtual Material *	FindMaterialByName (const char *pName, bool recursive)

virtual void	BindAnimation (AnimTransform *pAnimTrans, bool recursive)

virtual void	UnbindAnimation (AnimTransform *pAnimTrans, bool recursive)

virtual void	UnbindAllAnimation (bool recursive)

virtual void	UnbindAnimationSelf (AnimTransform *pAnimTrans)

virtual AnimationLink *	FindAnimationLinkSelf (AnimTransform *pAnimTrans)

virtual AnimationLink *	FindAnimationLinkSelf (const AnimResource &)

virtual void	SetAnimationEnable (AnimTransform *pAnimTrans, bool enable, bool recursive)

virtual void	SetAnimationEnable (const AnimResource &, bool enable, bool recursive)

virtual bool	GetMaterialNum () const

virtual Material *	GetMaterial () const

virtual Material *	GetMaterial (ulong) const

virtual void	LoadMtx (const DrawInfo &rInfo)

void	AppendChild (Pane *pChild)

void	RemoveChild (Pane *pChild)

ut::Rect	GetPaneRect (const DrawInfo &rInfo) const

void	AddAnimationLink (AnimationLink *pAnimLink)

math::VEC2	GetVtxPos () const

u16	GetExtUserDataNum () const

const res::ExtUserData *	GetExtUserData () const

const res::ExtUserData *	FindExtUserDataByName (const char *name)

Pane *	GetParent () const

PaneList &	GetChildList ()

void	SetSRTElement (ulong idx, f32 value)

const math::VEC3 &	GetTranslate () const

void	SetTranslate (const math::VEC2 &rTransXY)

void	SetTranslate (const math::VEC3 &rTrans)

const math::VEC3 &	GetRotate () const

void	SetRotate (const math::VEC3 &rRotate)

const math::VEC2 &	GetScale () const

void	SetScale (const math::VEC2 &rScale)

const Size &	GetSize () const

void	SetSize (const Size &rSize)

const math::MTX34 &	GetMtx () const

void	SetMtx (const math::MTX34 &rMtx)

const math::MTX34 &	GetGlobalMtx () const

void	SetGlobalMtx (const math::MTX34 &rGlbMtx)

u8	GetAlpha () const

void	SetAlpha (u8 alpha)

u8	GetGlbAlpha () const

void	SetGlbAlpha (u8 alpha)

u8	GetBasePositionH () const

void	SetBasePositionH (u8 position)

u8	GetBasePositionV () const

void	SetBasePositionV (u8 position)

bool	IsVisible () const

void	SetVisible (bool visible)

bool	IsInfluencedAlpha () const

void	SetInfluencedAlpha (bool influenced)

bool	IsLocationAdjust () const

void	SetLocationAdjust (bool adjust)

const char *	GetName () const

void	SetName (const char *pName)

const char *	GetUserData () const

void	SetUserData (const char *pUserData)

bool	IsUserAllocated () const

Public Member Functions inherited from nw4r::lyt::detail::PaneBase
	NW4R_UT_LINKLIST_NODE_DECL ()

Private Member Functions
void	setMessage (MsgRes_c bmg, ulong messageGroup, ulong messageID, long placeholderCount, va_list vargs)
	Sets the message to display in the text box with a va_list.

void	setText (const wchar_t text, long placeholderCount, va_list vargs, MsgRes_c *bmg)
	Sets the text to display in the text box with a va_list.

Additional Inherited Members
Protected Member Functions inherited from nw4r::lyt::Pane
void	InsertChild (PaneList::Iterator next, Pane *pChild)

Protected Attributes inherited from nw4r::lyt::TextBox
wchar_t *	mTextBuf

ut::Color	mTextColors [TEXTCOLOR_MAX]

const ut::Font *	mpFont

Size	mFontSize

f32	mLineSpace

f32	mCharSpace

ut::WideTagProcessor *	mpTagProcessor

u16	mTextBufBytes

u16	mTextLen

u8	mTextPosition

struct {

u8 bAllocFont: 1

}	mBits

Protected Attributes inherited from nw4r::lyt::Pane
Pane *	mpParent

PaneList	mChildList

AnimationLinkList	mAnimList

Material *	mpMaterial

math::VEC3	mTranslate

math::VEC3	mRotate

math::VEC2	mScale

Size	mSize

math::MTX34	mMtx

math::MTX34	mGlbMtx

ulong	mExtUserDataNum

u8	mAlpha

u8	mGlbAlpha

u8	mBasePosition

u8	mFlag

char	mName [NW4R_LYT_RES_NAME_LEN+1]

char	mUserData [NW4R_LYT_PANE_USERDATA_LEN+1]

bool	mbUserAllocated

u8	PADDING_0xD3

Member Function Documentation

◆ setMessage() [1/2]

void LytTextBox_c::setMessage	(	MsgRes_c *	bmg,
		ulong	messageGroup,
		ulong	messageID,
		long	placeholderCount,
			... )

Sets the message to display in the text box.

Parameters

bmg	The BMG resource.
messageID	The ID of the message to display.
messageGroup	The group of the message to display.
placeholderCount	The number of placeholders in the message.
...	Values for placeholders in the message.

Definition at line 7 of file d_lyttextbox.cpp.

◆ setText() [1/2]

void LytTextBox_c::setText	(	const wchar_t *	text,
		long	placeholderCount,
			... )

Sets the text to display in the text box.

Parameters

text	The text to display.
placeholderCount	The number of placeholders in the message.
...	Values for placeholders in the text.

Definition at line 77 of file d_lyttextbox.cpp.

◆ ExtensionUserDataSetup()

void LytTextBox_c::ExtensionUserDataSetup ( )

Checks for extension user data in the layout.

Definition at line 18 of file d_lyttextbox.cpp.

◆ setMessage() [2/2]

void LytTextBox_c::setMessage	(	MsgRes_c *	bmg,
		ulong	messageGroup,
		ulong	messageID,
		long	placeholderCount,
		va_list *	vargs )

private

Sets the message to display in the text box with a va_list.

Parameters

bmg	The BMG resource.
messageID	The ID of the message to display.
messageGroup	The group of the message to display.
placeholderCount	The number of placeholders in the message.
vargs	A va_list of values for placeholders in the message.

Definition at line 26 of file d_lyttextbox.cpp.

◆ setText() [2/2]

void LytTextBox_c::setText	(	const wchar_t *	text,
		long	placeholderCount,
		va_list *	vargs,
		MsgRes_c *	bmg )

private

Sets the text to display in the text box with a va_list.

Parameters

text	The text to display.
placeholderCount	The number of placeholders in the text.
vargs	A va_list of values for placeholders in the text.
bmg	The BMG resource.

Definition at line 84 of file d_lyttextbox.cpp.

Description

Public Member Functions

Private Member Functions

Additional Inherited Members

Member Function Documentation

◆ setMessage() [1/2]

◆ setText() [1/2]

◆ ExtensionUserDataSetup()

◆ setMessage() [2/2]

◆ setText() [2/2]