Draw XXL documentation


Draw Basics.Icon(...);

Draws an Icon symbol.

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


static void DrawBasics.Icon(...);

Code snippet names: drawIcon_rotViaVec and drawIcon_rotViaVec_func.

Parameters:
Type Parameter Name Description
Vector3 position
IconType icon
Color color
float size
string text
Vector3 normal Uses DrawShapes.automaticOrientationOfFlatShapes if not specified.
Vector3 up_insideIconPlane Uses DrawShapes.automaticOrientationOfFlatShapes if not specified.
int strokeWidth_asPPMofSize
bool mirrorHorizontally
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 DrawBasics.Icon(...);

Code snippet names: drawIcon_rotViaQuat and drawIcon_rotViaQuat_func.

Parameters:
Type Parameter Name Description
Vector3 position
IconType icon
Color color
float size
string text
Quaternion rotation Identity rotation means that the icon is inside the XY-2D-plane and unmirrored visible when looking along the z axis. Uses DrawShapes.automaticOrientationOfFlatShapes if not specified.
int strokeWidth_asPPMofSize
bool mirrorHorizontally
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.