DgsSetPosition: Difference between revisions

Revision as of 06:29, 3 August 2019

This function sets the position of a DGS element.

Syntax

bool dgsSetPosition ( element theElement, float x, float y, bool relative [, bool isCenterPosition = false ] )

Required Arguments

theElement: The DGS element to change position for
x: Position over the X axis
y: Position over the Y axis
relative: This is whether sizes and positioning are relative. If this is true, then all x,y,width,height floats must be between 0 and 1, representing sizes relative to the parent.

Optional Arguments

isCenterPosition: A bool of whether the input x/y is the center position of a dgs element.

Returns

Returns true if the position has been successfully set, false otherwise.

Example

This example creates a label. When an element is clicked, the label displays in the position of the element telling you what kind of element you have clicked. It hides after 5 seconds.

DGS = exports.dgs
--create an empty label
local myLabel = DGS:dgsCreateLabel  ( 0, 0, 1, 1, "", true )

function addLabelOnClick ( button, state, absoluteX, absoluteY, worldX, worldY, worldZ, clickedElement )
	--if an element was clicked on screen
	if ( clickedElement ) then
		--retreive the element type
		local elementType = DGS:dgsGetType ( clickedElement )
		--change the label text to that element type
		DGS:dgsSetText ( myLabel, elementType )
		--and place it in the position of where the element is
		DGS:dgsSetPosition ( myLabel, absoluteX, absoluteY, false )
		--hide the text by passing an empty string 5 seconds later
		setTimer ( DGS:dgsSetText, 5000, 1, myLabel, "" )
	end
end
addEventHandler ( "onDgsMouseClick", getRootElement(), addLabelOnClick )

Custom Cursor Functions

Multi Language Supports

Animation

3D Element

3D Interface

3D Line

3D Image

3D Text

Browser

dgsCreateBrowser

Button

Check Box

Combo Box

Custom Renderer

Edit

Detect Area

Drag'N Drop

Grid List

Image

Memo

Label

Layout

Line

Progress Bar

Radio Button

Scale Pane

Scroll Bar

Scroll Pane

Selector

Style

Switch Button

Tab Panel

Window

Basic Shape Plugins

Circle

Quadrilateral

Rounded Rectangle

Other Plugins

Blur Box

Canvas

dgsCreateCanvas

Chart

Color Picker

Effect 3D

Gradient

Mask

Media Browser

Nine Slice

Object Preview Supports

Paste Handler

QRCode

Remote Image

Screen Source

SVG

Tooltips

@@ Line 5: / Line 5: @@
 ==Syntax==
 <syntaxhighlight lang="lua">
-bool dgsSetPosition ( element theElement, float x, float y, bool relative )
+bool dgsSetPosition ( element theElement, float x, float y, bool relative [, bool isCenterPosition = false ] )
 </syntaxhighlight>
@@ Line 14: / Line 14: @@
 *'''y:''' Position over the Y axis
 *'''relative:''' This is whether sizes and positioning are relative. If this is true, then all x,y,width,height floats must be between 0 and 1, representing sizes relative to the parent.
+===Optional Arguments===
+*'''isCenterPosition:''' A bool of whether the input x/y is the center position of a dgs element.
 ===Returns===