Final Fantasy theme styled border. More...

#include <FinalFantasyFrame.hpp>

Inheritance diagram for nom::FinalFantasyFrame:

Public Types
typedef FinalFantasyFrame	self_type
typedef self_type *	raw_ptr
typedef std::shared_ptr< self_type >	shared_ptr
typedef std::unique_ptr< self_type >	unique_ptr
Public Types inherited from nom::Transformable
typedef Transformable	self_type
Public Types inherited from nom::IDrawable
typedef IDrawable	self_type
typedef self_type *	raw_ptr
	A type definition for a C pointer – raw pointer – to an IDrawable object.
typedef std::unique_ptr< self_type >	unique_ptr
	A type definition for a C++11 std::unique_ptr to an IDrawable object.
typedef std::shared_ptr< self_type >	shared_ptr
	A type definition for a C++11 std::shared_ptr to an IDrawable object.
typedef const RenderWindow	RenderTarget
Public Types inherited from nom::IObject
typedef IObject	self_type
typedef IObject *	raw_ptr

Public Member Functions
	FinalFantasyFrame (void)
	Default constructor; initialize the object to an invalid object state – position and size objects are invalid (null).
	~FinalFantasyFrame (void)
	Destructor.
	FinalFantasyFrame (const Point2i &pos, const Size2i &size)
IDrawable::raw_ptr	clone (void) const
	Implements required IDrawable::clone method.
bool	valid (void) const
	Query the validity of the object for rendering.
ObjectTypeInfo	type (void) const
	Re-implements the IObject::type method.
const IntRect &	frame_bounds (void) const
	Get the unaffected rendering area coordinates of the border.
void	draw (RenderTarget &target) const
	Implements IDrawable::draw.
void	set_frame_bounds (const IntRect &bounds)
	Set the intended boundaries of the "client area", meaning the unaffected rendering area of the rendered border.
Public Member Functions inherited from nom::Transformable
	Transformable (const Point2i &pos, const Size2i &size)
	Transformable (const IntRect &bounds)
	Construct an object using a complete set of coordinates (bounds).
ObjectTypeInfo	type () const override
	Re-implements the IObject::type method.
const Point2i &	position (void) const
	Getter for stored positioning coordinates.
const Size2i &	size (void) const
	Getter for stored size dimensions.
virtual void	set_position (const Point2i &coords)
	Set the positioning – X & Y rendering coordinates – of the object.
virtual void	set_size (const Size2i &size)
	Set the size dimensions– width & height rendering coordinates of the object.
virtual void	set_bounds (const IntRect &bounds)
	Set the complete bounds of the object – position (X, Y) and size (width and height) dimensions.
void	set_position (int x, int y)
void	set_size (int w, int h)
virtual void	translate (const Point2i &pos)
Public Member Functions inherited from nom::IDrawable
	IDrawable (void)
	Do nothing at all default constructor.
virtual	~IDrawable (void)
	Do nothing at all destructor.
Public Member Functions inherited from nom::IObject
	IObject (void)
	Default constructor.
virtual	~IObject (void)
	Virtual destructor.
virtual bool	is_type (const ObjectTypeInfo &rhs) const
	Compare this object type with another object's type.

Private Member Functions
void	update (void)
	Implements IDrawable::update.

Private Attributes
IntRect	frame_bounds_
	The rendering area unaffected by the rendered border.
Drawables	drawables_

Additional Inherited Members
Static Public Member Functions inherited from nom::IObject
template<typename Base, typename Derived>
static bool	is_a (const Derived object)
	Compare two objects to determine if a derived class inherits from a base class object.
static void *	operator new (nom::size_type mem)
static void	operator delete (void *ptr)
Static Public Attributes inherited from nom::IObject
static uint64	total_alloc_bytes
static uint64	total_dealloc_bytes

Detailed Description

Final Fantasy theme styled border.

Todo: Relocate to graphics folder?

Member Typedef Documentation

◆ raw_ptr

typedef self_type* nom::FinalFantasyFrame::raw_ptr

Definition at line 49 of file FinalFantasyFrame.hpp.

◆ self_type

typedef FinalFantasyFrame nom::FinalFantasyFrame::self_type

Definition at line 47 of file FinalFantasyFrame.hpp.

◆ shared_ptr

typedef std::shared_ptr<self_type> nom::FinalFantasyFrame::shared_ptr

Definition at line 50 of file FinalFantasyFrame.hpp.

◆ unique_ptr

typedef std::unique_ptr<self_type> nom::FinalFantasyFrame::unique_ptr

Definition at line 51 of file FinalFantasyFrame.hpp.

Member Function Documentation

◆ draw()

void nom::FinalFantasyFrame::draw ( RenderTarget & target ) const

virtual

Implements IDrawable::draw.

Implements nom::IDrawable.

◆ set_frame_bounds()

void nom::FinalFantasyFrame::set_frame_bounds ( const IntRect & bounds )

Set the intended boundaries of the "client area", meaning the unaffected rendering area of the rendered border.

Remarks: The boundary coordinates should exclude the rendering area used by the rendering of the border, leaving only what is free (think: safe) for others to render on.

Note: This information is provided as a convenience for visual interfaces that require such detial about their environment, such as a GUI engine – nom::UIWidget and friends.

◆ type()

ObjectTypeInfo nom::FinalFantasyFrame::type ( void ) const

virtual

Re-implements the IObject::type method.

Remarks: This uniquely identifies the object's type.

Reimplemented from nom::IDrawable.

◆ update()

void nom::FinalFantasyFrame::update ( void )

privatevirtual

Implements IDrawable::update.

Implements nom::IDrawable.

◆ valid()

bool nom::FinalFantasyFrame::valid ( void ) const

Query the validity of the object for rendering.

Remarks: A valid object must have both the positioning & size bounding coordinates be set to a non-null object value.

Member Data Documentation

◆ drawables_

Drawables nom::FinalFantasyFrame::drawables_

private

Remarks: This object internally tracks its object state for when to clear its cached data and update.

Definition at line 106 of file FinalFantasyFrame.hpp.

◆ frame_bounds_

IntRect nom::FinalFantasyFrame::frame_bounds_

private

The rendering area unaffected by the rendered border.

Definition at line 102 of file FinalFantasyFrame.hpp.

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

/home/jeff/Projects/nomlib.git/include/nomlib/gui/FinalFantasyFrame.hpp

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members