Draw XXL documentation


Draw Basics 2D.Circle(...);

Draws a 2D circle or oval.

Green parameters are required. Yellow parameters are optional, but have to be supplied in order.


static void DrawBasics2D.Circle(...);

Code snippet names: drawCircle2D_rect_defaultZ and drawCircle2D_rect_defaultZ_func.

Parameters:
Type Parameter Name Description
Rect hullRect
Color color
float linesWidth
string text
LineStyle lineStyle
float custom_zPos The z position of the XY-plane inside which the thing is drawn. The default value is "infinity", which falls back to DrawBasic2D.Default_zPos_forDrawing.
float stylePatternScaleFactor
LineStyle fillStyle
bool textBlockAboveLine
float durationInSec The duration in seconds how long the drawn thing stays visible. The default value of 0 means that it stays only during the current Update frame. Instead of using this parameter you can also overwrite him with a global setting so you don't always have to supply all other preceding function parameters till you reach this late parameter.
bool hiddenByNearerObjects This specifies if the drawn thing will get hidden if other geometry is in front of it or if it shines through. It is the same as the depthTest parameter of Unitys Debug.DrawLine(). Not all drawing methods support toggling this in the same way. For some methods the lines are fully hidden, for others the hidden lines shimmer through. Instead of using this parameter you can also overwrite him with a global setting so you don't always have to supply all other preceding function parameters till you reach this late parameter.


static void DrawBasics2D.Circle(...);

Code snippet names: drawCircle2D_vecRad_defaultZ and drawCircle2D_vecRad_defaultZ_func.

Parameters:
Type Parameter Name Description
Vector2 centerPosition
float radius
Color color
float linesWidth
string text
LineStyle lineStyle
float custom_zPos The z position of the XY-plane inside which the thing is drawn. The default value is "infinity", which falls back to DrawBasic2D.Default_zPos_forDrawing.
float stylePatternScaleFactor
LineStyle fillStyle
bool textBlockAboveLine
float durationInSec The duration in seconds how long the drawn thing stays visible. The default value of 0 means that it stays only during the current Update frame. Instead of using this parameter you can also overwrite him with a global setting so you don't always have to supply all other preceding function parameters till you reach this late parameter.
bool hiddenByNearerObjects This specifies if the drawn thing will get hidden if other geometry is in front of it or if it shines through. It is the same as the depthTest parameter of Unitys Debug.DrawLine(). Not all drawing methods support toggling this in the same way. For some methods the lines are fully hidden, for others the hidden lines shimmer through. Instead of using this parameter you can also overwrite him with a global setting so you don't always have to supply all other preceding function parameters till you reach this late parameter.