The IRectangle resource interface. More...

#include "murl_resource_i_rectangle.h"

Inherited by Murl::Resource::Atlas::AtlasRectangle, and Murl::Resource::NativeFont::NativeRectangle.

Public Member Functions

virtual UInt32 GetCode () const =0
 Get this rectangle's code value. More...
 
virtual Real GetTexCoordX1 () const =0
 Get the rectangle's start X texture coordinate (left). More...
 
virtual Real GetTexCoordY1 () const =0
 Get the rectangle's start Y texture coordinate (bottom). More...
 
virtual Real GetTexCoordX2 () const =0
 Get the rectangle's end X texture coordinate (right). More...
 
virtual Real GetTexCoordY2 () const =0
 Get the rectangle's end Y texture coordinate (top). More...
 
virtual Real GetCoordX1 () const =0
 Get the rectangle's start X screen coordinate (left). More...
 
virtual Real GetCoordY1 () const =0
 Get the rectangle's start Y screen coordinate (bottom). More...
 
virtual Real GetCoordX2 () const =0
 Get the rectangle's end X screen coordinate (right). More...
 
virtual Real GetCoordY2 () const =0
 Get the rectangle's end Y screen coordinate (top). More...
 
virtual Real GetSizeX () const =0
 Get the rectangle's actual size in X direction. More...
 
virtual Real GetSizeY () const =0
 Get the rectangle's actual size in Y direction. More...
 

Detailed Description

The IRectangle resource interface.

This interface represents a rectangle storing both screen and texture coordinates, used in Resource::IFont and Resource::IAtlas objects.

Member Function Documentation

◆ GetCode()

virtual UInt32 Murl::Resource::IRectangle::GetCode ( ) const
pure virtual

Get this rectangle's code value.

Returns
The code value.

◆ GetTexCoordX1()

virtual Real Murl::Resource::IRectangle::GetTexCoordX1 ( ) const
pure virtual

Get the rectangle's start X texture coordinate (left).

Returns
The start X texture coordinate.

◆ GetTexCoordY1()

virtual Real Murl::Resource::IRectangle::GetTexCoordY1 ( ) const
pure virtual

Get the rectangle's start Y texture coordinate (bottom).

Returns
The start Y texture coordinate.

◆ GetTexCoordX2()

virtual Real Murl::Resource::IRectangle::GetTexCoordX2 ( ) const
pure virtual

Get the rectangle's end X texture coordinate (right).

Returns
The end X texture coordinate.

◆ GetTexCoordY2()

virtual Real Murl::Resource::IRectangle::GetTexCoordY2 ( ) const
pure virtual

Get the rectangle's end Y texture coordinate (top).

Returns
The end Y texture coordinate.

◆ GetCoordX1()

virtual Real Murl::Resource::IRectangle::GetCoordX1 ( ) const
pure virtual

Get the rectangle's start X screen coordinate (left).

Returns
The start X screen coordinate.

◆ GetCoordY1()

virtual Real Murl::Resource::IRectangle::GetCoordY1 ( ) const
pure virtual

Get the rectangle's start Y screen coordinate (bottom).

Returns
The start Y screen coordinate.

◆ GetCoordX2()

virtual Real Murl::Resource::IRectangle::GetCoordX2 ( ) const
pure virtual

Get the rectangle's end X screen coordinate (right).

Returns
The end X screen coordinate.

◆ GetCoordY2()

virtual Real Murl::Resource::IRectangle::GetCoordY2 ( ) const
pure virtual

Get the rectangle's end Y screen coordinate (top).

Returns
The end Y screen coordinate.

◆ GetSizeX()

virtual Real Murl::Resource::IRectangle::GetSizeX ( ) const
pure virtual

Get the rectangle's actual size in X direction.

This value may actually be smaller than the difference of screen coordinates; in this case, the rectangle should be cropped accordingly.

Returns
The horizontal size.

◆ GetSizeY()

virtual Real Murl::Resource::IRectangle::GetSizeY ( ) const
pure virtual

Get the rectangle's actual size in Y direction.

This value may actually be smaller than the difference of screen coordinates; in this case, the rectangle should be cropped accordingly.

Returns
The vertical size.

The documentation for this interface was generated from the following file:
  • murl_resource_i_rectangle.h


Copyright © 2011-2024 Spraylight GmbH.