cGfx2D_L Class Reference

List of all members.

Public Member Functions

mixed Destroy (...)
 for lua : void Destroy ()
mixed InitPanel (...)
mixed InitCompass (...)
mixed InitCCPO (...)
mixed InitCCTO (...)
mixed InitBCCPO (...)
mixed InitSOC (...)
mixed InitRROC (...)
mixed InitText (...)
mixed SetPrepareFrameStep (...)
mixed SetVisible (...)
mixed SetTransparent (...)
mixed GetVisible (...)
 for lua : bool GetVisible ()
mixed SetMaterial (...)
mixed SetBorderMaterial (...)
mixed SetPos (...)
mixed GetPos (...)
mixed SetDimensions (...)
mixed GetDimensions (...)
 for lua : w,h = GetDimensions ()
mixed SetAlignment (...)
mixed SetTextAlignment (...)
mixed SetUV (...)
mixed SetPartUV (...)
mixed SetClip (...)
mixed SetBorder (...)
mixed SetCharHeight (...)
mixed SetFont (...)
mixed SetText (...)
mixed SetAutoWrap (...)
mixed SetColour (...)
mixed SetColours (...)
mixed SetPartColours (...)
mixed SetRotate (...)
mixed GetTextBounds (...)
mixed GetGlyphAtPos (...)
mixed GetGlyphBounds (...)
mixed GetLeft (...)
mixed GetTop (...)
mixed GetDerivedLeft (...)
mixed GetDerivedTop (...)
mixed GetWidth (...)
mixed GetHeight (...)
mixed RenderableBegin (...)
mixed RenderableVertex (...)
mixed RenderableIndex (...)
mixed RenderableIndex3 (...)
mixed RenderableSkipVertices (...)
 void RenderableSkipVertices (int iNumberOfVerticesToSkip)
mixed RenderableSkipIndices (...)
 void RenderableSkipIndices (int iNumberOfVerticesToSkip)
mixed RenderableEnd (...)
 void RenderableEnd ()
mixed SOC_ChildBringToFront (...)
mixed SOC_ChildSendToBack (...)
 void SOC_ChildSendToBack (gfx2d_child)
mixed SOC_ChildInsertAfter (...)
 void SOC_ChildInsertAfter (gfx2d_child,gfx2d_other)
mixed SOC_ChildInsertBefore (...)
 void SOC_ChildInsertBefore (gfx2d_child,gfx2d_other)
mixed SetUVMid (...)
mixed SetUVRad (...)
mixed SetAngBias (...)
mixed SetRankFactor (...)
mixed SetTrackPosSceneNode (...)
mixed SetTrackOffset (...)
mixed SetTrackMouse (...)

Static Public Member Functions

static mixed GetGfx2DCount (...)
static mixed CreateGfx2D (...)
 for lua : gfx2d CreateGfx2D ()
static mixed CreateCursorGfx2D (...)


Detailed Description

Definition at line 9139 of file lua_pseudo_code.cpp.


Member Function Documentation

static mixed cGfx2D_L::GetGfx2DCount (   ...  )  [inline, static]

static methods exported to lua returns the number of gfx3d objects that are currently allocated

Definition at line 9143 of file lua_pseudo_code.cpp.

static mixed cGfx2D_L::CreateGfx2D (   ...  )  [inline, static]

for lua : gfx2d CreateGfx2D ()

Definition at line 9146 of file lua_pseudo_code.cpp.

static mixed cGfx2D_L::CreateCursorGfx2D (   ...  )  [inline, static]

creates a gfx2d on kCursorOverlayZOrder, typically used for mouse cursors for lua : gfx2d CreateCursorGfx2D ()

Definition at line 9150 of file lua_pseudo_code.cpp.

mixed cGfx2D_L::Destroy (   ...  )  [inline]

for lua : void Destroy ()

Definition at line 9153 of file lua_pseudo_code.cpp.

mixed cGfx2D_L::InitPanel (   ...  )  [inline]

see also InitCCPO : ColorClipPaneOverlay for lua : void InitPanel (gfx2d_parent=0)

Definition at line 9157 of file lua_pseudo_code.cpp.

mixed cGfx2D_L::InitCompass (   ...  )  [inline]

iris specific compass widget, TODO : remove me ? might need plugin system or redesign for lua : void InitCompass (gfx2d_parent=0)

Definition at line 9161 of file lua_pseudo_code.cpp.

mixed cGfx2D_L::InitCCPO (   ...  )  [inline]

ColorClipPaneOverlay for lua : void InitCCPO (gfx2d_parent=0)

Definition at line 9165 of file lua_pseudo_code.cpp.

mixed cGfx2D_L::InitCCTO (   ...  )  [inline]

ColorClipTextOverlay for lua : void InitCCTO (gfx2d_parent=0)

Definition at line 9169 of file lua_pseudo_code.cpp.

mixed cGfx2D_L::InitBCCPO (   ...  )  [inline]

BorderColorClipPaneOverlay for lua : void InitBCCPO (gfx2d_parent=0)

Definition at line 9173 of file lua_pseudo_code.cpp.

mixed cGfx2D_L::InitSOC (   ...  )  [inline]

SortedOverlayContainer for lua : void InitSOC (gfx2d_parent=0)

Definition at line 9177 of file lua_pseudo_code.cpp.

mixed cGfx2D_L::InitRROC (   ...  )  [inline]

RobRenderableOverlayContainer for lua : void InitRROC (gfx2d_parent=0)

Definition at line 9181 of file lua_pseudo_code.cpp.

mixed cGfx2D_L::InitText (   ...  )  [inline]

Text Overlay ( see also ColorClipTextOverlay above ) for lua : void InitText (gfx2d_parent=0)

Definition at line 9185 of file lua_pseudo_code.cpp.

mixed cGfx2D_L::SetPrepareFrameStep (   ...  )  [inline]

if true, a framestep method is called every frame, used for calculating position and similar for lua : void SetPrepareFrameStep (bActive)

Definition at line 9189 of file lua_pseudo_code.cpp.

mixed cGfx2D_L::SetVisible (   ...  )  [inline]

TODO : find out and document if this affects children as well (e.g. if you set a container visible=false, are the childs hidden) see also SetTransparent for lua : void SetVisible (bVis)

Definition at line 9194 of file lua_pseudo_code.cpp.

mixed cGfx2D_L::SetTransparent (   ...  )  [inline]

for overlays prevents drawing, similar to SetVisible, TODO : detailed description and look up what this does exactly, i think it prevents drawing of container background but not of the childs see also SetVisible for lua : void SetTransparent (bTransparent)

Definition at line 9200 of file lua_pseudo_code.cpp.

mixed cGfx2D_L::GetVisible (   ...  )  [inline]

for lua : bool GetVisible ()

Definition at line 9203 of file lua_pseudo_code.cpp.

mixed cGfx2D_L::SetMaterial (   ...  )  [inline]

sets material (inner for BorderColorClipPaneOverlay) for lua : void SetMaterial (sMatName);

Definition at line 9207 of file lua_pseudo_code.cpp.

mixed cGfx2D_L::SetBorderMaterial (   ...  )  [inline]

for BorderColorClipPaneOverlay, sets the material of the border for lua : void SetBorderMaterial(sMatName)

Definition at line 9211 of file lua_pseudo_code.cpp.

mixed cGfx2D_L::SetPos (   ...  )  [inline]

position for lua : void SetPos(x,y)

Definition at line 9215 of file lua_pseudo_code.cpp.

mixed cGfx2D_L::GetPos (   ...  )  [inline]

position for lua : x,y GetPos ()

Definition at line 9219 of file lua_pseudo_code.cpp.

mixed cGfx2D_L::SetDimensions (   ...  )  [inline]

size for lua : void SetDimensions (w,h)

Definition at line 9223 of file lua_pseudo_code.cpp.

mixed cGfx2D_L::GetDimensions (   ...  )  [inline]

for lua : w,h = GetDimensions ()

Definition at line 9226 of file lua_pseudo_code.cpp.

mixed cGfx2D_L::SetAlignment (   ...  )  [inline]

for lua : void SetAlignment (iHAlign,iVAlign) iHAlign : kGfx2DAlign_Left , kGfx2DAlign_Right , kGfx2DAlign_Center iVAlign : kGfx2DAlign_Top , kGfx2DAlign_Bottom , kGfx2DAlign_Center

Definition at line 9231 of file lua_pseudo_code.cpp.

mixed cGfx2D_L::SetTextAlignment (   ...  )  [inline]

iHAlign : kGfx2DAlign_Left , kGfx2DAlign_Right , kGfx2DAlign_Center for lua : void SetTextAlignment(iTextAlign)

Definition at line 9235 of file lua_pseudo_code.cpp.

mixed cGfx2D_L::SetUV (   ...  )  [inline]

for lua : void SetUV (float u1, float v1, float u2, float v2) left,top = u1,u2 right,bottom = u2,v2

Definition at line 9239 of file lua_pseudo_code.cpp.

mixed cGfx2D_L::SetPartUV (   ...  )  [inline]

for lua : void SetPartUV (int iPartID,float u1, float v1, float u2, float v2) left,top = u1,u2 right,bottom = u2,v2 texturecoordinates iPartID = kBCCPOPart_LT T RT L R LB B RB M : L=Left T=Top R=Right B=Bottom M=Middle

Definition at line 9244 of file lua_pseudo_code.cpp.

mixed cGfx2D_L::SetClip (   ...  )  [inline]

for lua : void SetClip (float left,float top,float width,float height) ColorClipPaneOverlay ColorClipPaneOverlay ColorClipTextOverlay warning : this function is rather lowlevel and requires absolute coordinates, so you have to update the widget during movement or so

Definition at line 9249 of file lua_pseudo_code.cpp.

mixed cGfx2D_L::SetBorder (   ...  )  [inline]

for lua : void SetBorder (float left,float top,float right,float bottom) for BorderColourClipPaneOverlay (the "width" of the border parts on left,top,right,bottom)

Definition at line 9253 of file lua_pseudo_code.cpp.

mixed cGfx2D_L::SetCharHeight (   ...  )  [inline]

for lua : void SetCharHeight (float height) set font-size for text (InitText) and ColorClipTextOverlay (InitCCTO) the height in pixels of a char (todo:sure about pixels? might also be in some screen-relative format..)

Definition at line 9258 of file lua_pseudo_code.cpp.

mixed cGfx2D_L::SetFont (   ...  )  [inline]

for text (InitText) and ColorClipTextOverlay (InitCCTO) set font for text (InitText) and ColorClipTextOverlay (InitCCTO) for lua : void SetFont (sFontName)

Definition at line 9263 of file lua_pseudo_code.cpp.

mixed cGfx2D_L::SetText (   ...  )  [inline]

for text (InitText) and ColorClipTextOverlay (InitCCTO) uses mpOverlayElement->setCaption, so it might work on other types as well automatically later (we currently only have those two) for lua : void SetText (sText)

Definition at line 9269 of file lua_pseudo_code.cpp.

mixed cGfx2D_L::SetAutoWrap (   ...  )  [inline]

for lua : void SetAutoWrap (iMaxW) -- usually in pixels text is wrapped automatically if it is too long : newlines are inserted on word boundaries.

Definition at line 9273 of file lua_pseudo_code.cpp.

mixed cGfx2D_L::SetColour (   ...  )  [inline]

for lua : void SetColour (r,g,b,a) for ColorClipPaneOverlay, BorderColorClipPaneOverlay(same color for all edges), and ColorClipTextOverlay uses mpOverlayElement->setColour , so it might work automatically for future widgets

Definition at line 9278 of file lua_pseudo_code.cpp.

mixed cGfx2D_L::SetColours (   ...  )  [inline]

lt:left top , rb:right bottom for lua : void SetColours ((lt:)r,g,b,a, (rt:)r,g,b,a, (lb:)r,g,b,a, (rb:)r,g,b,a)

Definition at line 9282 of file lua_pseudo_code.cpp.

mixed cGfx2D_L::SetPartColours (   ...  )  [inline]

lt:left top , rb:right bottom for lua : void SetPartColours (iPartID, (lt:)r,g,b,a, (rt:)r,g,b,a, (lb:)r,g,b,a, (rb:)r,g,b,a) iPartID = kBCCPOPart_LT T RT L R LB B RB M : L=Left T=Top R=Right B=Bottom M=Middle

Definition at line 9287 of file lua_pseudo_code.cpp.

mixed cGfx2D_L::SetRotate (   ...  )  [inline]

obsolete, doesn't do anything now for lua : void SetRotate (angle)

Definition at line 9291 of file lua_pseudo_code.cpp.

mixed cGfx2D_L::GetTextBounds (   ...  )  [inline]

only for cColourClipTextOverlay for lua : w,h GetTextBounds ()

Definition at line 9295 of file lua_pseudo_code.cpp.

mixed cGfx2D_L::GetGlyphAtPos (   ...  )  [inline]

only for cColourClipTextOverlay GlyphIndex at position, if this returns 1234, then the "letter" displayed at the position was text[1234] for lua : int GetGlyphAtPos (x,y)

Definition at line 9300 of file lua_pseudo_code.cpp.

mixed cGfx2D_L::GetGlyphBounds (   ...  )  [inline]

only for cColourClipTextOverlay for lua : l,t,r,b GetGlyphBounds(iGlyphIndex) GlyphIndex is for example the index returned from GetGlyphAtPos

Definition at line 9305 of file lua_pseudo_code.cpp.

mixed cGfx2D_L::GetLeft (   ...  )  [inline]

for lua : float GetLeft () in coordinates relative to the parent coordinate system

Definition at line 9309 of file lua_pseudo_code.cpp.

mixed cGfx2D_L::GetTop (   ...  )  [inline]

for lua : float GetTop () in coordinates relative to the parent coordinate system

Definition at line 9313 of file lua_pseudo_code.cpp.

mixed cGfx2D_L::GetDerivedLeft (   ...  )  [inline]

for lua : float GetDerivedLeft () in absolute coordinates (todo : is this pixels or in screen-relative [-1;1]?)

Definition at line 9317 of file lua_pseudo_code.cpp.

mixed cGfx2D_L::GetDerivedTop (   ...  )  [inline]

for lua : float GetDerivedTop () in absolute coordinates (todo : is this pixels or in screen-relative [-1;1]?)

Definition at line 9321 of file lua_pseudo_code.cpp.

mixed cGfx2D_L::GetWidth (   ...  )  [inline]

for lua : float GetWidth () (todo : is this pixels or in screen-relative [-1;1]?)

Definition at line 9325 of file lua_pseudo_code.cpp.

mixed cGfx2D_L::GetHeight (   ...  )  [inline]

for lua : float GetHeight () (todo : is this pixels or in screen-relative [-1;1]?)

Definition at line 9329 of file lua_pseudo_code.cpp.

mixed cGfx2D_L::RenderableBegin (   ...  )  [inline]

for lua : void RenderableBegin (iVertexCount,iIndexCount,bDynamic,bKeepOldIndices,opType) optype like OT_TRIANGLE_LIST

Definition at line 9333 of file lua_pseudo_code.cpp.

mixed cGfx2D_L::RenderableVertex (   ...  )  [inline]

must be called between RenderableBegin and RenderableEnd Real : 1 float Vector3 : 3 floats x,y,z ColourValue : 4 floats r,g,b,a void RenderableVertex (float,float,float,...); void RenderableVertex (...)

Definition at line 9341 of file lua_pseudo_code.cpp.

mixed cGfx2D_L::RenderableIndex (   ...  )  [inline]

must be called between RenderableBegin and RenderableEnd void RenderableIndex (iIndex)

Definition at line 9345 of file lua_pseudo_code.cpp.

mixed cGfx2D_L::RenderableIndex3 (   ...  )  [inline]

must be called between RenderableBegin and RenderableEnd void RenderableIndex3 (iIndex,iIndex,iIndex)

Definition at line 9349 of file lua_pseudo_code.cpp.

mixed cGfx2D_L::RenderableSkipVertices (   ...  )  [inline]

void RenderableSkipVertices (int iNumberOfVerticesToSkip)

Definition at line 9352 of file lua_pseudo_code.cpp.

mixed cGfx2D_L::RenderableSkipIndices (   ...  )  [inline]

void RenderableSkipIndices (int iNumberOfVerticesToSkip)

Definition at line 9355 of file lua_pseudo_code.cpp.

mixed cGfx2D_L::RenderableEnd (   ...  )  [inline]

void RenderableEnd ()

Definition at line 9358 of file lua_pseudo_code.cpp.

mixed cGfx2D_L::SOC_ChildBringToFront (   ...  )  [inline]

***** ***** ***** ***** ***** SortedOverlayContainer void SOC_ChildBringToFront (gfx2d_child)

Definition at line 9362 of file lua_pseudo_code.cpp.

mixed cGfx2D_L::SOC_ChildSendToBack (   ...  )  [inline]

void SOC_ChildSendToBack (gfx2d_child)

Definition at line 9365 of file lua_pseudo_code.cpp.

mixed cGfx2D_L::SOC_ChildInsertAfter (   ...  )  [inline]

void SOC_ChildInsertAfter (gfx2d_child,gfx2d_other)

Definition at line 9368 of file lua_pseudo_code.cpp.

mixed cGfx2D_L::SOC_ChildInsertBefore (   ...  )  [inline]

void SOC_ChildInsertBefore (gfx2d_child,gfx2d_other)

Definition at line 9371 of file lua_pseudo_code.cpp.

mixed cGfx2D_L::SetUVMid (   ...  )  [inline]

***** ***** ***** ***** ***** rest only for cCompassOverlay for lua : void SetUVMid (u,v)

Definition at line 9376 of file lua_pseudo_code.cpp.

mixed cGfx2D_L::SetUVRad (   ...  )  [inline]

only for cCompassOverlay for lua : void SetUVRad (u,v)

Definition at line 9380 of file lua_pseudo_code.cpp.

mixed cGfx2D_L::SetAngBias (   ...  )  [inline]

only for cCompassOverlay for lua : void SetAngBias (ang) rotation ?

Definition at line 9385 of file lua_pseudo_code.cpp.

mixed cGfx2D_L::SetRankFactor (   ...  )  [inline]

only for cSortedOverlayContainer for lua : void SetRankFactor (int iRankFaktor) lowlevel access to a parameter used for a workaround for the ogre-overlay systems limitation of 650 overlay z orders

Definition at line 9390 of file lua_pseudo_code.cpp.

mixed cGfx2D_L::SetTrackPosSceneNode (   ...  )  [inline]

for lua : void SetTrackPosSceneNode(gfx3d or nil) set own pos to the projected(3d to 2d) position of a scenenode

Definition at line 9394 of file lua_pseudo_code.cpp.

mixed cGfx2D_L::SetTrackOffset (   ...  )  [inline]

for lua : void SetTrackOffset(float x,float y) specifies a position offset to be applied when tracking, see also SetTrackMouse SetTrackPosSceneNode

Definition at line 9398 of file lua_pseudo_code.cpp.

mixed cGfx2D_L::SetTrackMouse (   ...  )  [inline]

for lua : void SetTrackMouse(bool bOn) sets the pos to the mousepos every frame (you should call SetPrepareFrameStep(false) manually if you turn this off and nothing else requires stepping)

Definition at line 9403 of file lua_pseudo_code.cpp.


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

Generated on Fri Mar 29 05:41:09 2013 for lua by  doxygen 1.5.6