Draw XXL documentation

Draw Shapes.FlatShape(...);

Draws a Flat Shape. It is similar to DrawBasics2D.Shape(), but here the shape can be freely rotated in 3D space.

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

static int DrawShapes.FlatShape(...);

Code snippet names: drawFlatShape_baseRectQuat and drawFlatShape_baseRectQuat_func.

Parameters:

Type	Parameter Name	Description
Rect	hullRect	A rect that acts as hull for the shape. It lies initially inside the xy-plane and from there can be rotated via the "rotation" parameter.
Shape2DType	shapeType
float	zPos_ofRectCenter
Quaternion	rotation
Color	color
float	linesWidth
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	lineStyle
float	stylePatternScaleFactor
bool	flattenRoundLines_intoShapePlane
LineStyle	fillStyle	FillStyle is not suppported for non-convex shapes (that is: "stars").
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.FlatShape(...);

Code snippet names: drawFlatShape_baseRectVec and drawFlatShape_baseRectVec_func.

Parameters:

Type	Parameter Name	Description
Rect	hullRect	A rect that acts as hull for the shape. It lies initially inside the xy-plane and from there can be rotated via the "normal" and "up_insideShapePlane" parameters.
Shape2DType	shapeType
float	zPos_ofRectCenter
Vector3	normal
Vector3	up_insideShapePlane
Color	color
float	linesWidth
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	lineStyle
float	stylePatternScaleFactor
bool	flattenRoundLines_intoShapePlane
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 int DrawShapes.FlatShape(...);

Code snippet names: drawFlatShape_vecQuat and drawFlatShape_vecQuat_func.

Parameters:

Type	Parameter Name	Description
Vector3	centerPosition
Shape2DType	shapeType
float	width
float	height
Color	color
Quaternion	rotation	rotationforward is the normal direction of the flat shape. rotationup defines the upward direction inside the flat shape. If not specified then DrawShapes.automaticOrientationOfFlatShapes is used.
float	linesWidth
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	lineStyle
float	stylePatternScaleFactor
bool	flattenRoundLines_intoShapePlane
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 int DrawShapes.FlatShape(...);

Code snippet names: drawFlatShape_vecVec and drawFlatShape_vecVec_func.

Parameters:

Type	Parameter Name	Description
Vector3	centerPosition
Shape2DType	shapeType
float	width
float	height
Color	color
Vector3	normal	This uses DrawShapes.automaticOrientationOfFlatShapes if not specified.
Vector3	up_insideShapePlane	This uses DrawShapes.automaticOrientationOfFlatShapes if not specified.
float	linesWidth
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	lineStyle
float	stylePatternScaleFactor
bool	flattenRoundLines_intoShapePlane
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.