nomlib
Loading...
Searching...
No Matches
nom::IDecorator Class Referenceabstract

Abstract class for Decorator objects. More...

#include <IDecorator.hpp>

Inheritance diagram for nom::IDecorator:
[legend]

Public Types

typedef IDecorator self_type
typedef self_type * raw_ptr
typedef std::unique_ptr< self_type > unique_ptr
typedef std::shared_ptr< self_type > shared_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 IObjectraw_ptr

Public Member Functions

 IDecorator (void)
 Default constructor.
virtual ~IDecorator (void)
 Destructor.
virtual IntRect margins (void) const =0
virtual IntRect frame_bounds (void) const =0
virtual void invalidate (void)=0
virtual void set_margins (const IntRect &margins)=0
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.
virtual void update (void)=0
virtual void draw (RenderTarget &) const =0
 Render the object onto the primary video buffer – your visible screen.
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.

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

Abstract class for Decorator objects.

Definition at line 41 of file IDecorator.hpp.

Member Typedef Documentation

◆ raw_ptr

typedef self_type* nom::IDecorator::raw_ptr

Definition at line 46 of file IDecorator.hpp.

◆ self_type

typedef IDecorator nom::IDecorator::self_type

Definition at line 44 of file IDecorator.hpp.

◆ shared_ptr

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

Definition at line 48 of file IDecorator.hpp.

◆ unique_ptr

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

Definition at line 47 of file IDecorator.hpp.

Constructor & Destructor Documentation

◆ IDecorator()

nom::IDecorator::IDecorator ( void )
inline

Default constructor.

Definition at line 51 of file IDecorator.hpp.

◆ ~IDecorator()

virtual nom::IDecorator::~IDecorator ( void )
inlinevirtual

Destructor.

Definition at line 57 of file IDecorator.hpp.

Member Function Documentation

◆ frame_bounds()

virtual IntRect nom::IDecorator::frame_bounds ( void ) const
pure virtual

Implemented in nom::Decorator.

◆ invalidate()

virtual void nom::IDecorator::invalidate ( void )
pure virtual

Implemented in nom::Decorator.

◆ margins()

virtual IntRect nom::IDecorator::margins ( void ) const
pure virtual

Implemented in nom::Decorator.

◆ set_margins()

virtual void nom::IDecorator::set_margins ( const IntRect & margins)
pure virtual

Implemented in nom::Decorator.


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