DrawCircle3D: Difference between revisions

From Onset Developer Wiki
No edit summary
No edit summary
 
(3 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Info|Function|Client|1.0}}
{{Info|Function|Client|1.0}}


{{FuncDescription|__EDIT_ME__}}
{{FuncDescription|Draws a circle in 3d space.}}


{{FuncSyntax|DrawCircle3D(x, y, z [, Radius])}}
{{FuncSyntax|DrawCircle3D(x, y, z, XAxisX, XAxisY, XAxisZ, YAxisX, YAxisY, YAxisZ [, Radius, bForeground])}}


{{FuncParameters}}
{{FuncParameters}}
{{FuncParam|x|__EDIT_ME__}}
{{FuncParam|x|World X location.}}
{{FuncParam|y|__EDIT_ME__}}
{{FuncParam|y|World Y location.}}
{{FuncParam|z |__EDIT_ME__}}
{{FuncParam|z|World Z location.}}
{{FuncParam|XAxisX|__EDIT_ME__}}
{{FuncParam|XAxisX|X axis alignment of the circle}}
{{FuncParam|XAxisY|__EDIT_ME__}}
{{FuncParam|XAxisY|X axis alignment of the circle}}
{{FuncParam|XAxisZ|__EDIT_ME__}}
{{FuncParam|XAxisZ|X axis alignment of the circle}}
{{FuncParam|YAxisX|__EDIT_ME__}}
{{FuncParam|YAxisX|Y axis alignment of the circle}}
{{FuncParam|YAxisY|__EDIT_ME__}}
{{FuncParam|YAxisY|Y axis alignment of the circle}}
{{FuncParam|YAxisZ|__EDIT_ME__}}
{{FuncParam|YAxisZ|Y axis alignment of the circle}}
{{FuncParamOptional|Radius|__EDIT_ME__}}
{{FuncParamOptional|Radius|The circle radius, default: 1.0}}
{{FuncParamOptional|bForeground|'''true''' to draw in front of geometry, default: false}}


{{FuncReturnValue|__EDIT_ME__}}
{{FuncReturnValue|Returns nothing.}}


== Example ==
== Example ==
__EDIT_ME__
Example usage can be found in the map editor script package:
https://github.com/BlueMountainsIO/OnsetLuaScripts/blob/6f45ad9607e30c97f4f1d58443d808da632d4d91/mapeditor/client/editor.lua#L164


{{RelatedFunctions}}
{{RelatedFunctions}}
__EDIT_ME__
* [[DrawText]]
* [[SetDrawColor]]
* [[SetTextDrawScale]]
* [[GetTextSize]]
* [[DrawLine]]
* [[DrawLine3D]]
* [[DrawPoint3D]]
* [[DrawCircle3D]]
* [[DrawBox]]
* [[DrawRect]]
* [[DrawTexture]]
* [[DrawTextureEx]]
* [[DrawMaterial]]

Latest revision as of 20:25, 30 August 2020

DrawCircle3D

Type: Function
Context: Client
Introduced: v1.0

Description

Draws a circle in 3d space.

Syntax

DrawCircle3D(x, y, z, XAxisX, XAxisY, XAxisZ, YAxisX, YAxisY, YAxisZ [, Radius, bForeground])

Parameters

  • x
    World X location.
  • y
    World Y location.
  • z
    World Z location.
  • XAxisX
    X axis alignment of the circle
  • XAxisY
    X axis alignment of the circle
  • XAxisZ
    X axis alignment of the circle
  • YAxisX
    Y axis alignment of the circle
  • YAxisY
    Y axis alignment of the circle
  • YAxisZ
    Y axis alignment of the circle
  • Radius (optional)
    The circle radius, default: 1.0
  • bForeground (optional)
    true to draw in front of geometry, default: false

Return Value

  • Returns nothing.

Example

Example usage can be found in the map editor script package: https://github.com/BlueMountainsIO/OnsetLuaScripts/blob/6f45ad9607e30c97f4f1d58443d808da632d4d91/mapeditor/client/editor.lua#L164

See also