Guiliani  Version 2.4 revision 5970 (build 3)
CGUIBitmapPlane Class Reference

The bitmap plane base class. More...

#include <GUIBitmapPlane.h>

Inheritance diagram for CGUIBitmapPlane:

Public Member Functions

GUIBitmapPlaneID_t GetID () const
 
2D positioning
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
 
3D positioning
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
 
Rotation
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 ()
 
Size
virtual void SetWidth (eC_Value vWidth, eC_Bool bExpandCentered=false)
 
eC_Value GetWidth () const
 
eC_Value GetWidthCorrected () const
 
virtual void SetHeight (eC_Value vHeight, eC_Bool bExpandCentered=false)
 
eC_Value GetHeight () const
 
eC_Value GetHeightCorrected () const
 
void SetBytesPerPixel (const eC_UByte &ubBPP)
 
eC_UByte GetBytesPerPixel () const
 
void SetAutoScale (const eC_Bool bAutoScale)
 
Drawing
virtual void DoDraw ()
 
virtual void GetData (eC_TArray< eC_UByte > *pkData)
 
virtual void Clear (const eC_UByte ubRed=0, const eC_UByte ubGreen=0, const eC_UByte ubBlue=0, const eC_UByte ubAlpha=0)
 
const CGUIObjectGetParentGUIObject () const
 
virtual void SetAlphaValues (const eC_UByte ubTopLeft, const eC_UByte ubBottomLeft, const eC_UByte ubBottomRight, const eC_UByte ubTopRight)
 
void SetAlphaValue (const eC_UByte ubAlpha)
 
Texturing Top Left
virtual void SetTopLeftU (eC_Value vU)
 
virtual eC_Value GetTopLeftU ()
 
virtual void SetTopLeftV (eC_Value vV)
 
virtual eC_Value GetTopLeftV ()
 
void SetTopLeftUV (eC_Value vU, eC_Value vV)
 
Texturing Bottom Left
virtual void SetBottomLeftU (eC_Value vU)
 
virtual eC_Value GetBottomLeftU ()
 
virtual void SetBottomLeftV (eC_Value vV)
 
virtual eC_Value GetBottomLeftV ()
 
void SetBottomLeftUV (eC_Value vU, eC_Value vV)
 
Texturing Bottom Right
virtual void SetBottomRightU (eC_Value vU)
 
virtual eC_Value GetBottomRightU ()
 
virtual void SetBottomRightV (eC_Value vV)
 
virtual eC_Value GetBottomRightV ()
 
void SetBottomRightUV (eC_Value vU, eC_Value vV)
 
Texturing Top Right
virtual void SetTopRightU (eC_Value vU)
 
virtual eC_Value GetTopRightU ()
 
virtual void SetTopRightV (eC_Value vV)
 
virtual eC_Value GetTopRightV ()
 
void SetTopRightUV (eC_Value vU, eC_Value vV)
 
Projection
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 (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)
 
Avtivation/Deactivation
virtual eC_Bool FinishDrawToBitmap ()
 
virtual eC_Bool DrawToBitmap ()
 
virtual eC_Bool DrawToScreen ()
 

Protected Attributes

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].
 

Friends

class CGfxWrap
 

Detailed Description

The bitmap plane base class.

This class defines the standard interface for every BitmapPlane.

Constructor & Destructor Documentation

◆ CGUIBitmapPlane()

CGUIBitmapPlane::CGUIBitmapPlane ( GUIBitmapPlaneID_t  uiNewBitmapID,
const CGUIObject rkParentObject,
eC_Value  vWidth = 0,
eC_Value  vHeight = 0 
)
protected

only the derived classes and GfxWrapper are allowed to create or destroy BitmapPlanes.

Parameters
uiNewBitmapIDid of the newly generated bitmap-plane
rkParentObjectparent-object
vWidthwidth
vHeightheight

Member Function Documentation

◆ Clear()

virtual void CGUIBitmapPlane::Clear ( const eC_UByte  ubRed = 0,
const eC_UByte  ubGreen = 0,
const eC_UByte  ubBlue = 0,
const eC_UByte  ubAlpha = 0 
)
inlinevirtual

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

Parameters
ubRedis the red part of the clear color
ubGreenis the green part of the clear color
ubBlueis the blue part of the clear color
ubAlphais the alpha part of the clear color

Reimplemented in CGUIBitmapPlane_eGML, CGUIBitmapPlane_DAVE, CGUIBitmapPlane_RGA, CGUIBitmapPlaneDirectFb, CGUIBitmapPlane_GL, and CGUIBitmapPlane_BLU.

◆ DisableDepthTest()

void CGUIBitmapPlane::DisableDepthTest ( )
inline

Disables the DepthTest for this Plane. If DepthCorrection is disabled the BitmapPlane will always be visible if the parent object is visible. The Z Position of the Plane is ignored for visibility check. DepthTest is not supported on all Graphics Wrappers.

See also
DisableDepthTest()

◆ DoDraw()

void CGUIBitmapPlane::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 in CGUIBitmapPlane_DAVE, CGUIBitmapPlane_RGA, CGUIBitmapPlane_eGML, CGUIBitmapPlaneDirectFb, CGUIBitmapPlane_BLU, and CGUIBitmapPlane_GL.

◆ DrawToBitmap()

virtual eC_Bool CGUIBitmapPlane::DrawToBitmap ( )
inlineprotectedvirtual

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

Returns
always true

Reimplemented in CGUIBitmapPlane_eGML, CGUIBitmapPlane_GL, CGUIBitmapPlane_RGA, CGUIBitmapPlaneDirectFb, CGUIBitmapPlane_FBO, and CGUIBitmapPlane_PBuffer.

◆ DrawToScreen()

virtual eC_Bool CGUIBitmapPlane::DrawToScreen ( )
inlineprotectedvirtual

Called by the framework when subsequent drawing operations shall happen on the normal UI screen.

Returns
always true

Reimplemented in CGUIBitmapPlane_GL, CGUIBitmapPlaneDirectFb, CGUIBitmapPlane_FBO, and CGUIBitmapPlane_PBuffer.

◆ EnableDepthTest()

void CGUIBitmapPlane::EnableDepthTest ( )
inline

Enables the DepthTest for this Plane. If DepthCorrection is enabled the BitmapPlane may be partly or completely invisible, even if its parent Object is completely visible, because if the DepthTest is enabled the visibility depends on the Z-Position. DepthTest is not supported on all Graphics Wrappers.

See also
EnableDepthTest()

◆ FinishDrawToBitmap()

virtual eC_Bool CGUIBitmapPlane::FinishDrawToBitmap ( )
inlineprotectedvirtual

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

Returns
always true

Reimplemented in CGUIBitmapPlane_eGML, CGUIBitmapPlaneDirectFb, and CGUIBitmapPlane_PBuffer.

◆ Get2DPlaneDistance()

eC_Value CGUIBitmapPlane::Get2DPlaneDistance ( )
virtual

Calculates the distance where 10, 10 rect has the size of 10, 10 pixel

Returns
z-distance of the 2D plane

Reimplemented in CGUIBitmapPlane_GL.

◆ GetBottomLeftU()

eC_Value CGUIBitmapPlane::GetBottomLeftU ( )
virtual

Accessor for the lower left U value.

Returns
U value of the lower left corner of the bitmap plane.

◆ GetBottomLeftV()

eC_Value CGUIBitmapPlane::GetBottomLeftV ( )
virtual

Accessor for the lower left V value.

Returns
U value of the lower left corner of the bitmap plane.

Reimplemented in CGUIBitmapPlane_GL.

◆ GetBottomRightU()

eC_Value CGUIBitmapPlane::GetBottomRightU ( )
virtual

Accesoor for the lower right U value.

Returns
U value of the lower right corner of the bitmap plane.

◆ GetBottomRightV()

eC_Value CGUIBitmapPlane::GetBottomRightV ( )
virtual

Accessor for the lower right V value.

Returns
U value of the lower right corner of the bitmap plane.

Reimplemented in CGUIBitmapPlane_GL.

◆ GetBytesPerPixel()

eC_UByte CGUIBitmapPlane::GetBytesPerPixel ( ) const
inline

Accessor for the number of bytes per pixel

Returns
bytes per pixel

◆ GetCenterOfProjectionAbsX()

eC_Value CGUIBitmapPlane::GetCenterOfProjectionAbsX ( ) const
protected

Accessor for the x coordinate of the center of projection. The center of projection is center of origin, by default it is the center of the parent GUIObject

Returns
x coordinate of the Center of projection

◆ GetCenterOfProjectionAbsY()

eC_Value CGUIBitmapPlane::GetCenterOfProjectionAbsY ( ) const
protected

Accessor for the y coordinate of the center of projection. The center of projection is center of origin, by default it is the center of the parent GUIObject

Returns
y coordinate of the Center of projection

◆ GetData()

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

Return the data in an array

Parameters
pkData

Reimplemented in CGUIBitmapPlane_eGML, CGUIBitmapPlane_DAVE, CGUIBitmapPlane_GL, and CGUIBitmapPlane_BLU.

◆ GetFar()

eC_Value CGUIBitmapPlane::GetFar ( ) const
inline
Returns
far plane for viewing frustum

◆ GetFOV()

eC_Value CGUIBitmapPlane::GetFOV ( ) const
inline
Returns
static Near/Far Plane and Field of View, these values are the same for all CGUIBitmaps

◆ GetHeight()

eC_Value CGUIBitmapPlane::GetHeight ( ) const
inline

Accessor for the height.

Returns
height of this BitmapPlane.

◆ GetHeightCorrected()

eC_Value CGUIBitmapPlane::GetHeightCorrected ( ) const

Accessor for the height, corrected by the deformation of the parent GUIObject.

Returns
corrected height of this BitmapPlane.

◆ GetID()

GUIBitmapPlaneID_t CGUIBitmapPlane::GetID ( ) const
inline

Accessor for the unique BitmapPlane ID.

Returns
unique BitmapPlane ID.

◆ GetNear()

eC_Value CGUIBitmapPlane::GetNear ( ) const
inline
Returns
near plane for viewing frustum

◆ GetParentGUIObject()

const CGUIObject& CGUIBitmapPlane::GetParentGUIObject ( ) const
inline

Accessor for parent GUIObject

Returns
const reference to the parent GUIObject

◆ GetTopLeftU()

eC_Value CGUIBitmapPlane::GetTopLeftU ( )
virtual

Accessor for the upper left U value.

Returns
U value of the upper left corner of the bitmap plane.

◆ GetTopLeftV()

eC_Value CGUIBitmapPlane::GetTopLeftV ( )
virtual

Accessor for the upper left V value.

Returns
U value of the upper left corner of the bitmap plane.

Reimplemented in CGUIBitmapPlane_GL.

◆ GetTopRightU()

eC_Value CGUIBitmapPlane::GetTopRightU ( )
virtual

Accessor for the upper right U value.

Returns
U value of the upper right corner of the bitmap plane.

◆ GetTopRightV()

eC_Value CGUIBitmapPlane::GetTopRightV ( )
virtual

Accessor for the upper right V value.

Returns
U value of the upper right corner of the bitmap plane.

Reimplemented in CGUIBitmapPlane_GL.

◆ GetWidth()

eC_Value CGUIBitmapPlane::GetWidth ( ) const
inline

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

Returns
width of this BitmapPlane.

◆ GetWidthCorrected()

eC_Value CGUIBitmapPlane::GetWidthCorrected ( ) const

Accessor for the width, corrected by the deformation of the parent GUIObject.

Returns
corrected width of this BitmapPlane.

◆ GetXAngle()

eC_Value CGUIBitmapPlane::GetXAngle ( ) const
inline

Accessor for X-Angle.

Returns
X-Angle in degree.

◆ GetXPos()

eC_Value CGUIBitmapPlane::GetXPos ( ) const
inline

Accesor for the X-Position in 3D space.

Returns
x coordinate.

◆ GetXPos2D()

eC_Value CGUIBitmapPlane::GetXPos2D ( ) const

Accesor for the X-Position in screen coordinates.

Returns
x coordinate relative to the upper left corner of the parent GUIObject.

◆ GetYAngle()

eC_Value CGUIBitmapPlane::GetYAngle ( ) const
inline

Accessor for Y-Angle.

Returns
Y-Angle in degree.

◆ GetYPos()

eC_Value CGUIBitmapPlane::GetYPos ( ) const
inline

Accesor for the y-Position in 3D space.

Returns
y coordinate.

◆ GetYPos2D()

eC_Value CGUIBitmapPlane::GetYPos2D ( ) const

Accesor for the Y-Position in screen coordinates.

Returns
y coordinate relative to the upper left corner of the parent GUIObject.

◆ GetZAngle()

eC_Value CGUIBitmapPlane::GetZAngle ( ) const
inline

Accessor for Z-Angle.

Returns
Z-Angle in degree.

◆ GetZPos()

eC_Value CGUIBitmapPlane::GetZPos ( ) const
inline

Accesor for the Z-Position in 3D space.

Returns
z coordinate.

◆ IsDepthTestEnabled()

eC_Bool CGUIBitmapPlane::IsDepthTestEnabled ( ) const
inline

Checks whether the DepthTest is enabled or not.

Returns
True if DepthTest is enabled, otherwise False.
See also
EnableDepthTest()
DisableDepthTest()

◆ IsYFlipped()

eC_Bool CGUIBitmapPlane::IsYFlipped ( ) const
inline
Returns
true if y is flipped

◆ ResetRotation()

void CGUIBitmapPlane::ResetRotation ( )

Resets all three rotation angles.

◆ RotateX()

void CGUIBitmapPlane::RotateX ( const eC_Value  vXAngle)
inline

Sets the X-Rotation of this BitmapPlane. Object will be rotated around its center.

Parameters
vXAngleX-Angle in degree

◆ RotateY()

void CGUIBitmapPlane::RotateY ( const eC_Value  vYAngle)
inline

Sets the Y-Rotation of this BitmapPlane. Object will be rotated around its center.

Parameters
vYAngleY-Angle in degree

◆ RotateZ()

void CGUIBitmapPlane::RotateZ ( const eC_Value  vZAngle)
inline

Sets the Z-Rotation of this BitmapPlane. Object will be rotated around its center.

Parameters
vZAngleZ-Angle in degree

◆ SetAlphaValue()

void CGUIBitmapPlane::SetAlphaValue ( const eC_UByte  ubAlpha)
inline

Set one alpha value for all corners of the Bitmap plane.

Parameters
ubAlphaThe Alpha value for the Bitmap plane.

◆ SetAlphaValues()

virtual void CGUIBitmapPlane::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
ubTopLeftalpha value for the upper left corner
ubBottomLeftalpha value for the lower left corner
ubBottomRightalpha value for the lower right corner
ubTopRightalpha value for the upper right corner

Reimplemented in CGUIBitmapPlane_DAVE, CGUIBitmapPlane_RGA, CGUIBitmapPlane_eGML, CGUIBitmapPlaneDirectFb, CGUIBitmapPlane_BLU, and CGUIBitmapPlane_GL.

◆ SetAutoScale()

void CGUIBitmapPlane::SetAutoScale ( const eC_Bool  bAutoScale)
inline

Enables/Disables the AutoScale mode. If AutoScale mode is active the BitmapPlane is resized if the parent GUIObject is resized By default AutoScale mode is active

Parameters
bAutoScaleFalse if the autoscale mode should be disabled otherwise true

◆ SetBottomLeftU()

void CGUIBitmapPlane::SetBottomLeftU ( eC_Value  vU)
virtual

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
vUnew U value for the lower left corner. [0 1]

Reimplemented in CGUIBitmapPlane_eGML.

◆ SetBottomLeftUV()

void CGUIBitmapPlane::SetBottomLeftUV ( eC_Value  vU,
eC_Value  vV 
)
inline

Sets the U/V values for the lower left corner of the bitmap plane.

Parameters
vUnew U value for the lower left corner
vVnew V value for the lower left corner
See also
SetBottomLeftV, SetBottomLeftU

◆ SetBottomLeftV()

void CGUIBitmapPlane::SetBottomLeftV ( eC_Value  vV)
virtual

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
vVnew V value for the lower left corner. [0 1]

Reimplemented in CGUIBitmapPlane_eGML, and CGUIBitmapPlane_GL.

◆ SetBottomRightU()

void CGUIBitmapPlane::SetBottomRightU ( eC_Value  vU)
virtual

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
vUnew U value for the lower right corner. [0 1]

Reimplemented in CGUIBitmapPlane_eGML.

◆ SetBottomRightUV()

void CGUIBitmapPlane::SetBottomRightUV ( eC_Value  vU,
eC_Value  vV 
)
inline

Sets the U/V values for the lower right corner of the bitmap plane.

Parameters
vUnew U value for the lower right corner
vVnew V value for the lower right corner
See also
SetBottomRightV, SetBottomRightU

◆ SetBottomRightV()

void CGUIBitmapPlane::SetBottomRightV ( eC_Value  vV)
virtual

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
vVnew V value for the lower left corner. [0 1]

Reimplemented in CGUIBitmapPlane_eGML, and CGUIBitmapPlane_GL.

◆ SetBytesPerPixel()

void CGUIBitmapPlane::SetBytesPerPixel ( const eC_UByte &  ubBPP)
inline

Setter for the number of bytes per pixel

Parameters
ubBPPbytes per pixel

◆ SetFOV()

void CGUIBitmapPlane::SetFOV ( const eC_Value  vFOV)
inline
Parameters
vFOVstatic Near/Far Plane and Field of View, these values are the same for all CGUIBitmaps

◆ SetHeight()

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

Setter for the height.

Parameters
vHeightnew height of this BitmapPlane.
bExpandCenteredif true Plane will be expanded to top and bottom, otherwise only to the bottom. default is false

Reimplemented in CGUIBitmapPlane_eGML, and CGUIBitmapPlane_GL.

◆ SetPos2D()

void CGUIBitmapPlane::SetPos2D ( eC_Value  vXPos,
eC_Value  vYPos 
)

Sets the Position of this BitmapPlane in screen coordinates. Position will be set relative to the upper left corner of the parent GUIObject. The Z Coordinate will be set in that way that a 10x10 BitmapPlane has the size of 10x10 pixel on the screen

Parameters
vXPosx coordinate relative to the upper left corner of the parent GUIObject
vYPosy coordinate relative to the upper left corner of the parent GUIObject

◆ SetPos3D()

void CGUIBitmapPlane::SetPos3D ( eC_Value  vXPos,
eC_Value  vYPos,
eC_Value  vZPos 
)
inline

Sets the Position of this BitmapPlane in 3D space. Point of origin is the center of the parent GUIObject.

Parameters
vXPosx coordinate
vYPosy coordinate
vZPosz coordinate

◆ SetTexUsed()

void CGUIBitmapPlane::SetTexUsed ( eC_Value  vNewTexUsedU,
eC_Value  vNewTexUsedV 
)
protected

Sets a new value for the used texture part

Parameters
vNewTexUsedUnew u value representing the used part of the texture
vNewTexUsedVnew v value representing the used part of the texture

◆ SetTopLeftU()

void CGUIBitmapPlane::SetTopLeftU ( eC_Value  vU)
virtual

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
vUnew U value for the upper left corner. [0 1]

Reimplemented in CGUIBitmapPlane_eGML.

◆ SetTopLeftUV()

void CGUIBitmapPlane::SetTopLeftUV ( eC_Value  vU,
eC_Value  vV 
)
inline

Sets the U/V values for the top left corner of the bitmap plane.

Parameters
vUnew U value for the top left corner
vVnew V value for the top left corner
See also
SetTopLeftV, SetTopLeftU

◆ SetTopLeftV()

void CGUIBitmapPlane::SetTopLeftV ( eC_Value  vV)
virtual

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
vVnew V value for the upper left corner. [0 1]

Reimplemented in CGUIBitmapPlane_eGML, and CGUIBitmapPlane_GL.

◆ SetTopRightU()

void CGUIBitmapPlane::SetTopRightU ( eC_Value  vU)
virtual

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
vUnew U value for the upper left corner. [0 1]

Reimplemented in CGUIBitmapPlane_eGML.

◆ SetTopRightUV()

void CGUIBitmapPlane::SetTopRightUV ( eC_Value  vU,
eC_Value  vV 
)
inline

Sets the U/V values for the upper right corner of the bitmap plane.

Parameters
vUnew U value for the upper right corner
vVnew V value for the upper right corner
See also
SetTopRightV, SetTopRightU

◆ SetTopRightV()

void CGUIBitmapPlane::SetTopRightV ( eC_Value  vV)
virtual

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
vVnew V value for the upper left corner. [0 1]

Reimplemented in CGUIBitmapPlane_eGML, and CGUIBitmapPlane_GL.

◆ SetWidth()

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

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

Parameters
vWidthnew width of this BitmapPlane.
bExpandCenteredif true Plane will be expanded to left and right, otherwise only to the right. default is false

Reimplemented in CGUIBitmapPlane_eGML, and CGUIBitmapPlane_GL.

◆ SetXPos2D()

void CGUIBitmapPlane::SetXPos2D ( eC_Value  vXPos)

Sets the X-Position of this BitmapPlane in screen coordinates. Position will be set relative to the upper left corner of the parent GUIObject. The Z Coordinate will be set in that way that a 10x10 BitmapPlane has the size of 10x10 pixel on the screen

Parameters
vXPosx coordinate relative to the upper left corner of the parent GUIObject

◆ SetXPos3D()

void CGUIBitmapPlane::SetXPos3D ( const eC_Value  vXPos)
inline

Sets the X-Position of this BitmapPlane in 3D space. Point of origin is the center of the parent GUIObject.

Parameters
vXPosx coordinate

◆ SetYPos2D()

void CGUIBitmapPlane::SetYPos2D ( eC_Value  vYPos)

Sets the Y-Position of this BitmapPlane in screen coordinates. Position will be set relative to the upper left corner of the parent GUIObject. The Z Coordinate will be set in that way that a 10x10 BitmaPlane has the size of 10x10 pixel on the screen

Parameters
vYPosy coordinate relative to the upper left corner of the parent GUIObject

◆ SetYPos3D()

void CGUIBitmapPlane::SetYPos3D ( const eC_Value  vYPos)
inline

Sets the YPosition of this BitmapPlane in 3D space. Point of origin is the center of the parent GUIObject.

Parameters
vYPosy coordinate

◆ SetZPos3D()

void CGUIBitmapPlane::SetZPos3D ( const eC_Value  vZPos)
inline

Sets the Z-Position of this BitmapPlane in 3D space. Point of origin is the center of the parent GUIObject.

Parameters
vZPosz coordinate

Friends And Related Function Documentation

◆ CGfxWrap

friend class CGfxWrap
friend

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