DsImage Class Reference

DsImage is a class that implements a view capable of displaying an image. More...

#include <ds_image.h>

Inheritance diagram for DsImage:

Public Member Functions
	DsImage (DsView *parent, const DsPoint &pos=DsPoint(), const DsSize &size=DsSize())
	Creates a DsImage view without any surface attached (no content).
	DsImage (DsView *parent, const DsPoint &pos, const DsSize &size, const void *png, size_t png_size, bool alpha_only, DsColor color=OPAQUE, const DsAlignment &alignment=DS_ALIGN_CENTER)
	Creates a DsImage view using raw PNG data.
	DsImage (DsView *parent, const DsPoint &pos, const DsSize &size, const void *jpg, size_t jpg_size, const DsAlignment &alignment=DS_ALIGN_CENTER)
	Creates a DsImage view using raw JPEG data.
	DsImage (DsView *parent, const DsPoint &pos, const DsSize &size, const DsSurface &surface, DsColor color=OPAQUE, const DsAlignment &alignment=DS_ALIGN_CENTER)
	Creates a DsImage view using a surface.
	~DsImage ()
void	setImagePng (const void *png, size_t png_size, bool alpha_only=false, DsColor color=OPAQUE)
	Initializes the image using PNG data.
void	setImageJpg (const void *jpg, size_t jpg_size)
	Initializes the image using raw JPEG data.
void	setImage (const DsSurface *surface, DsColor color=OPAQUE)
	Initializes the image using a surface.
void	setImageColor (DsColor color)
	Sets the color used for drawing images that contain the alpha channel only (A8 type).
void	setAlignment (const DsAlignment &alignment)
	Sets the alignment used for the image inside the view.
Public Member Functions inherited from DsView
	DsView (DsView *parent, const DsPoint &pos=DsPoint(), const DsSize &size=DsSize())
	Creates a DsView with an optional position and size.
	DsView (DsView *parent, DsOrientation layout_orientation)
	Creates a DsView with the auto-layout mode active. This view can align it's children automatically.
void	addChild (DsView *view)
	Adds a child to the current DsView.
void	removeChild (DsView *view)
	Removes a child to the current DsView.
void	removeAllChildren (void)
	Removes all children of the current DsView.
void	bringFront (void)
	Brings the current view to the top of the drawing order.
void	sendBack (void)
	Sends the current view to the bottom of the drawing order.
DsView *	getParent (void) const
	Returns the parent of the current view.
void	setParent (DsView *parent)
	Sets a new parent to the view.
const DsPoint &	getPosition (void) const
	Returns the position of the view in parent coordinates.
DsFPoint	getCenterPoint (void) const
	Returns the center point of the view in current coordinates.
DsPoint	translatePositionInParentCoordinates (const DsView *parent, DsPoint pos) const
	Translates position (x, y) in parent coordinate system.
DsPoint	translatePositionInParentCoordinates (uint32_t parent_level, DsPoint pos) const
	Translates position (x, y) in parent coordinate system.
DsPoint	getPositionInParentCoordinates (const DsView *parent) const
	Returns the position in the parent's coordinate system.
void	setPosition (const DsPoint &pos)
	Sets the position of the view in parent coordinates.
void	setCenterPosition (const DsPoint &pos)
	Sets the position of the center of the view in parent coordinates.
void	centerVertically (DsView *view)
	Aligns vertically the center of the current view with the center of another view.
void	centerHorizontally (DsView *view)
	Aligns horizontally the center of the current view with the center of another view.
const DsSize &	getParentSize (void) const
	Returns the size of the parent view.
const DsSize &	getSize (void) const
	Returns the size of the view.
void	setMinimumSize (const DsSize &size)
	Returns the minimum size of the view.
void	setSize (const DsSize &size)
	Sets the size of the view.
void	setWidth (int32_t width)
	Sets the width of the view.
void	setHeight (int32_t height)
	Sets the height of the view.
DsRect	getRegion (void) const
	Returns a rectangle describing the space occupied by the current view in it's own coordinate system (X and Y coordinates are 0).
DsRect	getRegionInParentCoordinates (const DsView *parent) const
	Returns a rectangle describing the space occupied by the current view in the parent's coordinate system.
void	alignInParent (void)
	Aligns the view relative to it's parent.
void	alignInParent (const DsAlignment &alignment, int32_t padding_top, int32_t padding_left, int32_t padding_bottom, int32_t padding_right)
	Aligns the view relative to it's parent.
DsView *	setPaddingTop (int16_t padding, uint16_t proportion=0)
	Sets the top padding used by the auto-layout.
DsView *	setPaddingBottom (int16_t padding, uint16_t proportion=0)
	Sets the bottom padding used by the auto-layout.
DsView *	setPaddingLeft (int32_t padding, uint16_t proportion=0)
	Sets the left padding used by the auto-layout.
DsView *	setPaddingRight (int16_t padding, uint16_t proportion=0)
	Sets the right padding used by the auto-layout.
DsView *	setPadding (int16_t padding, uint16_t proportion=0)
	Sets the padding used by the auto-layout.
DsView *	setPaddingHorizontal (int16_t padding, uint16_t proportion=0)
	Sets the horizontal padding used by the auto-layout.
DsView *	setPaddingVertical (int16_t padding, uint16_t proportion=0)
	Sets the vertical padding used by the auto-layout.
DsView *	setProportion (uint32_t proportion)
	Sets the view proportion used by the auto-layout.
DsAlignment	getParentAlignment (void) const
	Returns parent alignment mode of the view.
DsView *	setParentAlignment (const DsAlignment &alignment)
	Sets parent alignment mode of the view.
void	reserveSpace (bool state)
	Configures if during auto-layout the view will reserve space even if it's hidden.
void	setAutoLayout (DsOrientation orientation, bool enable)
	Enables or disables the auto-layout mode and sets the primary orientation.
void	doLayout (void)
	Runs the auto-layout algorithm.
void	setBackgroundColor (DsColor color)
	Sets the background color of the view.
void	setBackgroundImage (const DsSurface *surface)
	Sets the background image.
void	setPanelColor (DsColor color)
	Sets the color of the panel.
void	setPanelBorderColor (DsColor color)
	Sets the color of the panel border.
void	setPanelCornerRadius (uint16_t radius)
	Sets the radius of the panel corners.
void	setPanelBorderThickness (uint8_t thickness)
	Sets the thickness of the panel border.
DsScreen &	getScreen (void)
	Returns a reference to the screen to which this view belongs.
bool	isFocused (void)
	Is the view focused?
bool	getIsVisible (void) const
	Is the view visibility enabled?
bool	isVisible (void) const
	Is the view actually visible on the screen?
bool	isParentVisible (void) const
	Is the parent view actually visible on the screen?
bool	show (void)
	Shortcut to setVisible(true).
bool	hide (void)
	Shortcut to setVisible(false).
bool	setVisible (bool is_visible)
	Changes the visibility of the view.
virtual void	onShow (void)
	This virtual method is called when the view becomes visible on the screen.
virtual void	onHide (void)
	This virtual method is called when the view becomes invisible (hidden) on the screen.
void	enable (bool state)
	Enables or disables the view.
bool	isEnabled (void) const
	Is the view enabled?
void	enableTouch (bool state)
	Enables or disables processing of touch events.
bool	isTouchEnabled (void) const
	Is the view enabled to process touch events?
void	sendTap (DsPoint pos)
	Sends a tap event to the view.
void	setOnTapCallback (const lambda< void(const DsPoint &p)> &cb)
	Sets the lambda to be executed when the user taps on the view.
void	setOnLongTapCallback (const lambda< void(const DsPoint &p)> &cb)
	Sets the lambda to be executed when the user taps the view and holds for a specific time (set with setLongTapDetection()).
void	setOnTouchActiveCallback (const lambda< void(const DsPoint &p)> &cb)
	Sets the lambda to be executed when the user touches the view.
void	setOnTouchReleaseCallback (const lambda< void(void)> &cb)
	Sets the lambda to be executed when the user touch is released.
void	setLongTapDetection (uint32_t delay_ms)
	Configures the long tap detection.
bool	isInputInside (void) const
	Returns if there is user input (touch) inside the view.
const DsPoint &	getTouchPosition (void) const
	Returns the location of the user touch input inside the view.
void	enableHorizontalScroll (bool state)
	Enables or disables the horizontal scroll of the view contents.
void	enableVerticalScroll (bool state)
	Enables or disables the vertical scroll of the view contents.
void	setScrollbarColor (DsColor color)
	Configure the color of the scroll bars.
virtual void	invalidate (void)
	Invalidates the view.
virtual void	invalidateRegion (DsRect region)
	Invalidates only a region of the view.
void	addStateObserver (StateObserver *observer)
	Adds a state observer object.
void	removeStateObserver (StateObserver *observer)
	Removes a state observer object.

Additional Inherited Members
Protected Member Functions inherited from DsView
virtual void	onChildAdd (DsView *child)
	This virtual method will be called when a new child had been added to the view.
virtual void	onSizeChange (void)
	This virtual method will be called when the size of the view changes.
virtual bool	onTouch (const DsTouchEvent &event)
	This virtual method will be called when there is touch user input.
virtual void	onVSync (void)
	This virtual method is be called at every vertical sync period.
virtual void	onKeyboard (int32_t key)
	This virtual method is called when there is a keyboard event that needs to be processed.
void	inputCapture (void)
	Captures the touch input.
bool	isInputCaptured (void) const
	Is the input captured?
void	skipInput (void)
	Skips receiving touch inputs until the end of the current touch event.
void	forAllChildren (const lambda< void(DsView *child)> &lambda)
	Calls the supplied lambda for every view in the children list.
void	forAllChildrenBackwards (const lambda< void(DsView *child)> &lambda)
	Calls the supplied lambda for every view in the children list.
Protected Attributes inherited from DsView
DsPoint	mScrollPosition
DsPoint	mPreviousScrollPosition
DsPoint	mScrollPositionBase
DsColor	mScrollbarColor
DsPoint	mTouchPos
uint32_t	mTouchTimestamp

Detailed Description

DsImage is a class that implements a view capable of displaying an image.

Constructor & Destructor Documentation

DsImage() [1/4]

DsImage::DsImage	(	DsView *	parent,
		const DsPoint &	pos = DsPoint(),
		const DsSize &	size = DsSize()
	)

Creates a DsImage view without any surface attached (no content).

Parameters

parent	The parent view
pos	The position of the view in the parent coordinate system
size	The size of the view

DsImage() [2/4]

DsImage::DsImage	(	DsView *	parent,
		const DsPoint &	pos,
		const DsSize &	size,
		const void *	png,
		size_t	png_size,
		bool	alpha_only,
		DsColor	color = OPAQUE,
		const DsAlignment &	alignment = DS_ALIGN_CENTER
	)

Creates a DsImage view using raw PNG data.

Parameters

parent	The parent view
pos	The position of the view in the parent coordinate system
size	The size of the view. If the size is set to (0, 0) it will be computed from the size of the source image.
png	Pointer to the raw PNG data
png_size	Size of the raw PNG data
alpha_only	In case of a grayscale PNG, use the pixel data to initialize a surface of type A8 (alpha only). This can be used for creating masks.
color	In case alpha_only is true, the color used to paint the surface
alignment	The alignment of the image inside the view

DsImage() [3/4]

DsImage::DsImage	(	DsView *	parent,
		const DsPoint &	pos,
		const DsSize &	size,
		const void *	jpg,
		size_t	jpg_size,
		const DsAlignment &	alignment = DS_ALIGN_CENTER
	)

Creates a DsImage view using raw JPEG data.

Parameters

parent	The parent view
pos	The position of the view in the parent coordinate system
size	The size of the view. If the size is set to (0, 0) it will be computed from the size of the source image.
jpg	Pointer to the raw JPEG data
jpg_size	Size of the raw JPEG data
alignment	The alignment of the image inside the view

DsImage() [4/4]

DsImage::DsImage	(	DsView *	parent,
		const DsPoint &	pos,
		const DsSize &	size,
		const DsSurface &	surface,
		DsColor	color = OPAQUE,
		const DsAlignment &	alignment = DS_ALIGN_CENTER
	)

Creates a DsImage view using a surface.

Parameters

parent	The parent view
pos	The position of the view in the parent coordinate system
size	The size of the view. If the size is set to (0, 0) it will be computed from the size of the source image.
surface	Reference to DsSurface object containing the source image
color	In case of an A8 surface, the color used to paint the surface
alignment	The alignment of the image inside the view

~DsImage()

DsImage::~DsImage

(

)

Destructor.

Member Function Documentation

setAlignment()

void DsImage::setAlignment

(

const DsAlignment &

alignment

)

Sets the alignment used for the image inside the view.

Parameters

alignment

Image alignment

setImage()

void DsImage::setImage	(	const DsSurface *	surface,
		DsColor	color = OPAQUE
	)

Initializes the image using a surface.

Parameters

screen	Pointer to the surface
color	If the surface contains the alpha channel only, color will be used to draw the image. The alpha channel supplied in the color will be multiplied with the alpha channel coming from the surface.

setImageColor()

void DsImage::setImageColor

(

DsColor

color

)

Sets the color used for drawing images that contain the alpha channel only (A8 type).

Parameters

color

Color

setImageJpg()

void DsImage::setImageJpg	(	const void *	jpg,
		size_t	jpg_size
	)

Initializes the image using raw JPEG data.

Parameters

jpg	Pointer to the raw JPEG data
jpg_size	Size of the raw JPEG data

setImagePng()

void DsImage::setImagePng	(	const void *	png,
		size_t	png_size,
		bool	alpha_only = false,
		DsColor	color = OPAQUE
	)

Initializes the image using PNG data.

Parameters

png	Pointer to the raw PNG data
png_size	Size of the raw PNG data
alpha_only	In case of a grayscale PNG, use the pixel data to initialize a surface of type A8 (alpha only). This can be used for creating masks.
color	In case of a grayscale PNG and alpha_only is true, the surface will be converted to

---

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

• inc/ds_image.h