Draw XXL documentation


Draw Shapes.Decagon(...);

Draws a decagon.

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


static int DrawShapes.Decagon(...);

Code snippet names: drawDecagon_rotViaQuat and drawDecagon_rotViaQuat_func.

Parameters:
Type Parameter Name Description
Vector3 centerPosition
float hullRadius
Color color
Quaternion rotation rotation*forward is the normal direction of the flat shape. rotation*up defines the upward direction inside the flat shape. If not specified then DrawShapes.automaticOrientationOfFlatShapes is used.
float lineWidth
string text The display orientation of the text follows DrawText.automaticTextOrientation. The text size scales relative to the extent of the drawn shape. If you want a constant text size, you can use DrawShapes.forcedConstantScreenspaceTextSize_relToScreenHeight_forTextAtShapes or DrawShapes.forcedConstantWorldspaceTextSize_forTextAtShapes.
LineStyle outlineStyle
float stylePatternScaleFactor
LineStyle fillStyle
bool filledWithSpokes
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 int DrawShapes.Decagon(...);

Code snippet names: drawDecagon_rotViaVec and drawDecagon_rotViaVec_func.

Parameters:
Type Parameter Name Description
Vector3 centerPosition
float hullRadius
Color color
Vector3 normal This uses DrawShapes.automaticOrientationOfFlatShapes if not specified.
Vector3 up_insideDecagonPlane This uses DrawShapes.automaticOrientationOfFlatShapes if not specified.
float lineWidth
string text The display orientation of the text follows DrawText.automaticTextOrientation. The text size scales relative to the extent of the drawn shape. If you want a constant text size, you can use DrawShapes.forcedConstantScreenspaceTextSize_relToScreenHeight_forTextAtShapes or DrawShapes.forcedConstantWorldspaceTextSize_forTextAtShapes.
LineStyle outlineStyle
float stylePatternScaleFactor
LineStyle fillStyle
bool filledWithSpokes
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.