The BitmapPlane Class for eGML. More...

#include <GUIBitmapPlane_eGML.h>

Inheritance diagram for CGUIBitmapPlane_eGML:

Public Member Functions
virtual void	Clear (const eC_UByte ubRed, const eC_UByte ubGreen, const eC_UByte ubBlue, const eC_UByte ubAlpha)

void	DoDraw ()

virtual void	GetData (eC_TArray< eC_UByte > *pkData)

const eGML_Bitmap *	GetInternalBitmap ()

virtual void	SetAlphaValues (const eC_UByte ubTopLeft, const eC_UByte ubBottomLeft, const eC_UByte ubBottomRight, const eC_UByte ubTopRight)

virtual void	SetBottomLeftU (eC_Value vU)

virtual void	SetBottomLeftV (eC_Value vV)

virtual void	SetBottomRightU (eC_Value vU)

virtual void	SetBottomRightV (eC_Value vV)

virtual void	SetHeight (eC_Value vHeight, eC_Bool bExpandCentered=false)

virtual void	SetTopLeftU (eC_Value vU)

virtual void	SetTopLeftV (eC_Value vV)

virtual void	SetTopRightU (eC_Value vU)

virtual void	SetTopRightV (eC_Value vV)

virtual void	SetWidth (eC_Value vWidth, eC_Bool bExpandCentered=false)

Public Member Functions inherited from CGUIBitmapPlane
GUIBitmapPlaneID_t	GetID () const

void	SetPos2D (eC_Value vXPos, eC_Value vYPos)

void	SetXPos2D (eC_Value vXPos)

void	SetYPos2D (eC_Value vYPos)

eC_Value	GetXPos2D () const

eC_Value	GetYPos2D () const

void	SetPos3D (eC_Value vXPos, eC_Value vYPos, eC_Value vZPos)

void	SetXPos3D (const eC_Value vXPos)

void	SetYPos3D (const eC_Value vYPos)

void	SetZPos3D (const eC_Value vZPos)

eC_Value	GetXPos () const

eC_Value	GetYPos () const

eC_Value	GetZPos () const

void	RotateX (const eC_Value vXAngle)

void	RotateY (const eC_Value vYAngle)

void	RotateZ (const eC_Value vZAngle)

eC_Value	GetXAngle () const

eC_Value	GetYAngle () const

eC_Value	GetZAngle () const

void	ResetRotation ()

eC_Value	GetWidth () const

eC_Value	GetWidthCorrected () const

eC_Value	GetHeight () const

eC_Value	GetHeightCorrected () const

void	SetBytesPerPixel (const eC_UByte &ubBPP)

eC_UByte	GetBytesPerPixel () const

void	SetFormat (const CGUICommonEnums::ImageType_t &eFormat)

CGUICommonEnums::ImageType_t	GetFormat () const

void	SetAutoScale (const eC_Bool bAutoScale)

const CGUIObject &	GetParentGUIObject () const

void	SetAlphaValue (const eC_UByte ubAlpha)

virtual eC_Value	GetTopLeftU ()

virtual eC_Value	GetTopLeftV ()

void	SetTopLeftUV (eC_Value vU, eC_Value vV)

virtual eC_Value	GetBottomLeftU ()

virtual eC_Value	GetBottomLeftV ()

void	SetBottomLeftUV (eC_Value vU, eC_Value vV)

virtual eC_Value	GetBottomRightU ()

virtual eC_Value	GetBottomRightV ()

void	SetBottomRightUV (eC_Value vU, eC_Value vV)

virtual eC_Value	GetTopRightU ()

virtual eC_Value	GetTopRightV ()

void	SetTopRightUV (eC_Value vU, eC_Value vV)

void	EnableDepthTest ()

void	DisableDepthTest ()

eC_Bool	IsDepthTestEnabled () const

virtual eC_Value	Get2DPlaneDistance ()

eC_Value	GetFOV () const

void	SetFOV (const eC_Value vFOV)

eC_Value	GetNear () const

eC_Value	GetFar () const

eC_Bool	IsYFlipped () const

Protected Member Functions
	CGUIBitmapPlane_eGML (GUIBitmapPlaneID_t uiNewBitmapID, const CGUIObject &rkParentObject, eC_Value vWidth, eC_Value vHeight)

void	CreateTexture ()
	Creates the eGMLTexture.

virtual eC_Bool	DrawToBitmap ()

virtual eC_Bool	FinishDrawToBitmap ()

void	SetTexture (eGML_Texture *pNewTexture)

void	UpdateUVValues ()
	Updates the Texture Start and the eGML U and V vector.

void	UpdateVertices ()
	Calculates the vertices in the vertex array.

Protected Member Functions inherited from CGUIBitmapPlane
	CGUIBitmapPlane (GUIBitmapPlaneID_t uiNewBitmapID, const CGUIObject &rkParentObject, eC_Value vWidth=0, eC_Value vHeight=0)

eC_Value	GetCenterOfProjectionAbsX () const

eC_Value	GetCenterOfProjectionAbsY () const

void	SetTexUsed (eC_Value vNewTexUsedU, eC_Value vNewTexUsedV)

virtual eC_Bool	DrawToScreen ()

Friends
class	CGfxWrapeGML
	friend class for private access

Additional Inherited Members
Protected Attributes inherited from CGUIBitmapPlane
eC_TArray< eC_Value >	m_avUVValues
	array containing the uv values for all four plane corners

eC_Bool	m_bAutoScale
	flag describing a bitmap plane will be automatically be scaled on GUIObject scale

eC_Bool	m_bYFlipped
	if data is upside down

eC_UInt	m_uiScreenHeight
	screen height, used to identify screen changes on calculation of 2DPlaneDistance

eC_UInt	m_uiScreenWidth
	screen width, used to identify screen changes on calculation of 2DPlaneDistance

eC_Value	m_v2DPlaneDistance
	2DPlaneDistance

eC_Value	m_vGUIObjectInitHeight
	Height of the GUIObject at creation time of this BitmapPlane.

eC_Value	m_vGUIObjectInitWidth
	Width of the GUIObject at creation time of this BitmapPlane.

eC_Value	m_vTexUsedU
	Used space/unused space in x direction in the Bitmap, due to Power of two limitations [0 1].

eC_Value	m_vTexUsedV
	Used space/unused space in y direction in the Bitmap, due to Power of two limitations [0 1].

Detailed Description

The BitmapPlane Class for eGML.

Platform Specific Limitations

Transparencies are not supported for GUIBitmapPlane_eGML. (Class CGUIBitmapPlane_eGML)

See CGUIBitmapPlane_eGML Platform Specific Limitations

Constructor & Destructor Documentation

◆ CGUIBitmapPlane_eGML()

CGUIBitmapPlane_eGML::CGUIBitmapPlane_eGML	(	GUIBitmapPlaneID_t	uiNewBitmapID,
		const CGUIObject &	rkParentObject,
		eC_Value	vWidth,
		eC_Value	vHeight
	)

protected

Constructor

Parameters

uiNewBitmapID	Bitmap ID
rkParentObject	Parent object
vWidth	Width
vHeight	Height

Member Function Documentation

◆ Clear()

virtual void CGUIBitmapPlane_eGML::Clear	(	const eC_UByte	ubRed,
		const eC_UByte	ubGreen,
		const eC_UByte	ubBlue,
		const eC_UByte	ubAlpha
	)

virtual

Clears this bitmap with the given color. Attention: Please note that clearing Alpha values is unfortunately not supported by all Graphics APIs!

Parameters

ubRed	is the red part of the clear color
ubGreen	is the green part of the clear color
ubBlue	is the blue part of the clear color
ubAlpha	is the alpha part of the clear color

Reimplemented from CGUIBitmapPlane.

◆ DoDraw()

void CGUIBitmapPlane_eGML::DoDraw ( )

virtual

Draws this BitmapPlane. The Bitmap will be drawn to the current RenderTarget, with the set rotation and position. The set cliprect also applies to this drawing.

Reimplemented from CGUIBitmapPlane.

◆ DrawToBitmap()

virtual eC_Bool CGUIBitmapPlane_eGML::DrawToBitmap ( )

protectedvirtual

Called by the framework when the drawing operation into the bitmapplane is about to begin.

Returns: always true

Reimplemented from CGUIBitmapPlane.

◆ FinishDrawToBitmap()

virtual eC_Bool CGUIBitmapPlane_eGML::FinishDrawToBitmap ( )

protectedvirtual

Called by the framework when the drawing operation into the bitmapplane has finished.

Returns: always true

Reimplemented from CGUIBitmapPlane.

◆ GetData()

virtual void CGUIBitmapPlane_eGML::GetData ( eC_TArray< eC_UByte > * pkData )

virtual

Return the data as array

Parameters

pkData

Reimplemented from CGUIBitmapPlane.

◆ GetInternalBitmap()

const eGML_Bitmap * CGUIBitmapPlane_eGML::GetInternalBitmap ( )

Retrieve the internal bitmap of the BitmapPlane. This bitmap can be deleted by the framework at any time and must not be stored by user code.

Returns: Pointer to internal eGML Bitmap of this bitmap plane.

◆ SetAlphaValues()

virtual void CGUIBitmapPlane_eGML::SetAlphaValues	(	const eC_UByte	ubTopLeft,
		const eC_UByte	ubBottomLeft,
		const eC_UByte	ubBottomRight,
		const eC_UByte	ubTopRight
	)

inlinevirtual

Sets the alpha values for all corners of the Bitmap plane.

Parameters

ubTopLeft	alpha value for the upper left corner
ubBottomLeft	alpha value for the lower left corner
ubBottomRight	alpha value for the lower right corner
ubTopRight	alpha value for the upper right corner

Reimplemented from CGUIBitmapPlane.

◆ SetBottomLeftU()

virtual void CGUIBitmapPlane_eGML::SetBottomLeftU ( eC_Value vU )

inlinevirtual

Sets the U Value of the lower left corner of the BitmapPlane. The U value describes which point of the Bitmap is mapped onto the plane in x direction. The value has to be between 0 and 1, where zero means the lower left corner of the plane maps directly on the left edge of the bitmap and 1 the lower left corner maps on the right edge of the bitmap. All values in between will be interpolated.

Parameters

vU	new U value for the lower left corner. [0 1]

Reimplemented from CGUIBitmapPlane.

◆ SetBottomLeftV()

virtual void CGUIBitmapPlane_eGML::SetBottomLeftV ( eC_Value vV )

inlinevirtual

Sets the V Value of the lower left corner of the BitmapPlane. The V value describes which point of the Bitmap is mapped onto the plane in y direction. The value has to be between 0 and 1, where zero means the lower left corner of the plane maps directly on the upper edge of the bitmap and 1 the lower left corner maps on the lower edge of the bitmap. All values in between will be interpolated.

Parameters

vV	new V value for the lower left corner. [0 1]

Reimplemented from CGUIBitmapPlane.

◆ SetBottomRightU()

virtual void CGUIBitmapPlane_eGML::SetBottomRightU ( eC_Value vU )

inlinevirtual

Sets the U Value of the bottom right corner of the BitmapPlane. The U value describes which point of the Bitmap is mapped onto the plane in x direction. The value has to be between 0 and 1, where zero means the lower right corner of the plane maps directly on the left edge of the bitmap and 1 the lower right corner maps on the right edge of the bitmap. All values in between will be interpolated.

Parameters

vU	new U value for the lower right corner. [0 1]

Reimplemented from CGUIBitmapPlane.

◆ SetBottomRightV()

virtual void CGUIBitmapPlane_eGML::SetBottomRightV ( eC_Value vV )

inlinevirtual

Sets the V Value of the lower left corner of the BitmapPlane. The V value describes which point of the Bitmap is mapped onto the plane in y direction. The value has to be between 0 and 1, where zero means the lower left corner of the plane maps directly on the upper edge of the bitmap and 1 the lower left corner maps on the lower edge of the bitmap. All values in between will be interpolated.

Parameters

vV	new V value for the lower left corner. [0 1]

Reimplemented from CGUIBitmapPlane.

◆ SetHeight()

virtual void CGUIBitmapPlane_eGML::SetHeight	(	eC_Value	vHeight,
		eC_Bool	bExpandCentered = `false`
	)

inlinevirtual

Setter for the height.

Parameters

vHeight	new height of this BitmapPlane.
bExpandCentered	if true Plane will be expanded to top and bottom, otherwise only to the bottom. default is false

Reimplemented from CGUIBitmapPlane.

◆ SetTexture()

void CGUIBitmapPlane_eGML::SetTexture ( eGML_Texture * pNewTexture )

protected

Sets the Texture for this BitmapPlane

Parameters

pNewTexture new texture

◆ SetTopLeftU()

virtual void CGUIBitmapPlane_eGML::SetTopLeftU ( eC_Value vU )

inlinevirtual

Sets the U Value of the upper left corner of the BitmapPlane. The U value describes which point of the Bitmap is mapped onto the plane in x direction. The value has to be between 0 and 1, where zero means the upper left corner of the plane maps directly on the left edge of the bitmap and 1 the upper left corner maps on the right edge of the bitmap. All values in between will be interpolated.

Parameters

vU	new U value for the upper left corner. [0 1]

Reimplemented from CGUIBitmapPlane.

◆ SetTopLeftV()

virtual void CGUIBitmapPlane_eGML::SetTopLeftV ( eC_Value vV )

inlinevirtual

Sets the V Value of the upper left corner of the BitmapPlane. The V value describes which point of the Bitmap is mapped onto the plane in y direction. The value has to be between 0 and 1, where zero means the upper left corner of the plane maps directly on the upper edge of the bitmap and 1 the upper left corner maps on the lower edge of the bitmap. All values in between will be interpolated.

Parameters

vV	new V value for the upper left corner. [0 1]

Reimplemented from CGUIBitmapPlane.

◆ SetTopRightU()

virtual void CGUIBitmapPlane_eGML::SetTopRightU ( eC_Value vU )

inlinevirtual

Sets the U Value of the upper right corner of the BitmapPlane. The U value describes which point of the Bitmap is mapped onto the plane in x direction. The value has to be between 0 and 1, where zero means the upper right corner of the plane maps directly on the left edge of the bitmap and 1 the upper right corner maps on the right edge of the bitmap. All values in between will be interpolated.

Parameters

vU	new U value for the upper left corner. [0 1]

Reimplemented from CGUIBitmapPlane.

◆ SetTopRightV()

virtual void CGUIBitmapPlane_eGML::SetTopRightV ( eC_Value vV )

inlinevirtual

Sets the V Value of the upper right corner of the BitmapPlane. The V value describes which point of the Bitmap is mapped onto the plane in y direction. The value has to be between 0 and 1, where zero means the upper right corner of the plane maps directly on the upper edge of the bitmap and 1 the upper right corner maps on the lower edge of the bitmap. All values in between will be interpolated.

Parameters

vV	new V value for the upper left corner. [0 1]

Reimplemented from CGUIBitmapPlane.

◆ SetWidth()

virtual void CGUIBitmapPlane_eGML::SetWidth	(	eC_Value	vWidth,
		eC_Bool	bExpandCentered = `false`
	)

inlinevirtual

Setter for the width. The scale parameter which will be used for the autoscale mechanism will be updated.

Parameters

vWidth	new width of this BitmapPlane.
bExpandCentered	if true Plane will be expanded to left and right, otherwise only to the right. default is false

Reimplemented from CGUIBitmapPlane.

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

GUIBitmapPlane_eGML.h

Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Platform Specific Limitations

Constructor & Destructor Documentation

◆ CGUIBitmapPlane_eGML()

Member Function Documentation

◆ Clear()

◆ DoDraw()

◆ DrawToBitmap()

◆ FinishDrawToBitmap()

◆ GetData()

◆ GetInternalBitmap()

◆ SetAlphaValues()

◆ SetBottomLeftU()

◆ SetBottomLeftV()

◆ SetBottomRightU()

◆ SetBottomRightV()

◆ SetHeight()

◆ SetTexture()

◆ SetTopLeftU()

◆ SetTopLeftV()

◆ SetTopRightU()

◆ SetTopRightV()

◆ SetWidth()