ASPiK SDK
VSTGUI::CNinePartTiledBitmap Class Reference

a nine-part tiled bitmap More...

#include <cbitmap.h>

Inheritance diagram for VSTGUI::CNinePartTiledBitmap:
VSTGUI::CBitmap VSTGUI::ReferenceCounted< T > VSTGUI::IReference

Public Member Functions

 CNinePartTiledBitmap (const CResourceDescription &desc, const CNinePartTiledDescription &offsets)
 
 CNinePartTiledBitmap (const PlatformBitmapPtr &platformBitmap, const CNinePartTiledDescription &offsets)
 
void draw (CDrawContext *context, const CRect &rect, const CPoint &offset=CPoint(0, 0), float alpha=1.f) override
 
Part Offsets
void setPartOffsets (const CNinePartTiledDescription &partOffsets)
 
const CNinePartTiledDescriptiongetPartOffsets () const
 
- Public Member Functions inherited from VSTGUI::CBitmap
 CBitmap (const CResourceDescription &desc)
 Create an image from a resource identifier.
 
 CBitmap (CCoord width, CCoord height)
 Create an image with a given size.
 
 CBitmap (CPoint size, double scaleFactor=1.)
 Create an image with a given size.
 
 CBitmap (const PlatformBitmapPtr &platformBitmap)
 
CCoord getWidth () const
 get the width of the image
 
CCoord getHeight () const
 get the height of the image
 
CPoint getSize () const
 get size of image
 
bool isLoaded () const
 check if image is loaded
 
const CResourceDescriptiongetResourceDescription () const
 
PlatformBitmapPtr getPlatformBitmap () const
 
void setPlatformBitmap (const PlatformBitmapPtr &bitmap)
 
bool addBitmap (const PlatformBitmapPtr &platformBitmap)
 
PlatformBitmapPtr getBestPlatformBitmapForScaleFactor (double scaleFactor) const
 
- Public Member Functions inherited from VSTGUI::ReferenceCounted< T >
 ReferenceCounted (const ReferenceCounted &)
 
ReferenceCountedoperator= (const ReferenceCounted &)
 
void forget () override
 decrease refcount and delete object if refcount == 0
 
void remember () override
 increase refcount
 
virtual int32_t getNbReference () const
 get refcount
 
virtual void beforeDelete ()
 

Protected Attributes

CNinePartTiledDescription offsets
 
- Protected Attributes inherited from VSTGUI::CBitmap
CResourceDescription resourceDesc
 
BitmapVector bitmaps
 

Additional Inherited Members

- Public Types inherited from VSTGUI::CBitmap
using PlatformBitmapPtr = SharedPointer< IPlatformBitmap >
 
- Protected Types inherited from VSTGUI::CBitmap
using BitmapVector = std::vector< PlatformBitmapPtr >
 

Detailed Description

a nine-part tiled bitmap

A nine-part tiled bitmap is tiled in nine parts which are drawing according to its part offsets:

  • top left corner
  • top right corner
  • bottom left corner
  • bottom right corner
  • top edge, repeated as often as necessary and clipped appropriately
  • left edge, dto.
  • right edge, dto.
  • bottom edge, dto.
  • center, repeated horizontally and vertically as often as necessary
|------------------------------------------------------------------------------------------------|
| Top-Left Corner    |         <----        Top Edge        ---->          |    Top-Right Corner |
|--------------------|-----------------------------------------------------|---------------------|
|         ^          |                         ^                           |          ^          |
|         |          |                         |                           |          |          |
|     Left Edge      |         <----         Center         ---->          |      Right Edge     |
|         |          |                         |                           |          |          |
|         v          |                         v                           |          v          |
|--------------------|-----------------------------------------------------|---------------------|
| Bottom-Left Corner |         <----       Bottom Edge      ---->          | Bottom-Right Corner |
|------------------------------------------------------------------------------------------------|

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