UTFWin::VariableWidthDrawable class
#include <Spore ModAPI/Spore/UTFWin/VariableWidthDrawable.h>

A drawable that completely fills the window of variable width with a graphic without a horizontal stretch.

Base classes

class IDrawable: A class that is capable of drawing a user interface component.
class DefaultLayoutElement: A default implementation of ILayoutElement.

auto GetImage() const -> Image*: Gets the background image.
auto SetImage(Image* pImage) -> void: Sets the background image.
auto GetFillColor() const -> Color: Gets the fill color that will be used if no image is specified.
auto SetFillColor(Color color) -> void: Sets the fill color that will be used if no image is specified.
auto ToDrawable() -> VariableWidthDrawable& virtual
auto AddRef() -> int override
auto Release() -> int override
auto Cast(uint32_t type) const -> void* override
auto SetSerializer(Serializer& dst) -> void override
auto GetProxyID() const -> uint32_t override: Returns the ID that identifies this type of element in a SPUI file.
auto Paint(UIRenderer* pRenderer, const Math::Rectangle& area, const RenderParams& params) -> void override: Paints this drawable onto the given UIRenderer.
auto IsColliding(const Math::Rectangle& area, const Math::Point& point, RenderParams& params) -> bool override: Tells whether the point specified is colliding in this drawable or not.
auto GetDimensions(Dimensions& dst, int state, int index) -> bool override: Used to get the dimensions of an image contained in this drawable.
auto UseCollision(uint32_t type, bool& dst) -> bool override: Tells whether the collision of a window should be handled by this drawable or not.

Sets the background image.

Parameters
pImage	The image.

Sets the fill color that will be used if no image is specified.

Parameters
color	The new fill color.

Paints this drawable onto the given UIRenderer.

Parameters
pRenderer	The UIRenderer where this must be drawn.
area	The area of the window to draw.
params	RenderParams that contain additional information (e.g. what image do draw, the current state, etc).

Tells whether the point specified is colliding in this drawable or not.

Parameters
area	The area of the window that is using this drawable.
point	The Point to check whether it collides or not. Its coordinates are relative to the window position.
params	Additional information, probably unused.

This method is useful for drawables that use hitmasks.

Used to get the dimensions of an image contained in this drawable.

Parameters
dst out	The Dimensions where the result must be written.
state	The current state flags of the window.
index	The index of the image whose dimensions must be returned.
Returns	True if the dimensions were got, false otherwise.

Tells whether the collision of a window should be handled by this drawable or not.

Parameters
type	The type, usually kDefaultCollisionType.
dst out	If the collision type is supported, whether it must be handled by this drawable or not.
Returns	True if the collision type is supported (even if it's not handled by this drawable), false otherwise.