Draw XXL documentation


Draw Basics.CircleSegment(...);

Draw a circle segment, like a wedge of a pie.

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


static void DrawBasics.CircleSegment(...);

Code snippet names: drawCircleSegment_vecToVec and drawCircleSegment_vecToVec_func.
Parameters:
Image Type Parameter Name Description
Vector3 centerOfCircle The center position of the circle.
Vector3 circleCenter_to_startPosOnPerimeter A vector that starts at the circle center and marks the beginning of the wedge. The length defines the circle radius, or is ignored if the "forceRadius" parameter overwrites it.
Vector3 circleCenter_to_endPosOnPerimeter A vector that starts at the circle center and marks the end of the wedge. The length is ignored since the radius is already defined by "circleCenter_to_startPosOnPerimeter" or "forceRadius".
Color color The color of the line.
float forceRadius This can be used to overwrite the circle radius that is normally taken from the "circleCenter_to_startPosOnPerimeter" parameter. The default value of 0 means that this "forceRadius" will be ignored.
string text An optional text to display along the perimeter. The text orientation follows cameraForAutomaticOrientation.
bool useReflexAngleOver180deg "circleCenter_to_startPosOnPerimeter" and "circleCenter_to_endPosOnPerimeter" are actually defining two wedges: An obtuse angle wedge below 180° and a reflex angle wedge above 180°. Use this bool to specify which one to draw.
float radiusPortionWhereDrawFillStarts The wedge doesn't have to be pointy on the inner side at the centerOfCircle, but the pie can have a hole at the center. This parameter defines the size of this hole. A value of 0 means that the wedge is fully pointy. A value of 1 means that only the perimeter is drawn.
bool skipFallbackDisplayOfZeroAngles A circle segment with an angle of 0 cannot be drawn. It is actually "not there". Sometimes this happens by accident and users may wonder why their drawing call doesn't have any effect. This is why Draw XXL displays an information tag at the position where the line should appear. There are cases though, were it is intended to allow zero angles and Draw XXLs information tag is disturbing. For these cases you can use the "skipFallbackDisplayOfZeroAngles" bool to omit the information tag.
float fillDensity The wedge is filled with lines to create the impression of a "filled" area. You can adjust the fill density, relative to the default value of 1.
float minAngleDeg_withoutTextLineBreak This affects the optional text that is drawn along the perimeter. If the drawn perimeter angle gets smaller then the text doesn't fit into this angle span anymore. To still be able to tag such segments with a text Draw XXL lets the text protrude the drawn segment on an imaginary longer curved perimeter line. This "minAngleDeg_withoutTextLineBreak" parameter specifies after which angle on the imaginary curved line the text line breaks will be done.
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.CircleSegment(...);

Code snippet names: drawCircleSegment_fromQuatUp and drawCircleSegment_fromQuatUp_func.
Parameters:
Image Type Parameter Name Description
Vector3 centerOfCircle The center of the circle.
Quaternion orientation A quaterion that rotates the whole circle object. Quaternion*forward is the turn axis of the circle. Quaternion*up defines the direction where the drawn circle segment will start.
float turnAngleDegCC_startingFromUp The circle segment starts at Quaternion*up and then turns by this angle (in degrees) counterclockwise(CC) when looking along Quaternion*forward
float radius The radius of the drawn circle segment.
Color color Same as in first overload. See there.
string text Same as in first overload. See there.
float radiusPortionWhereDrawFillStarts Same as in first overload. See there.
bool skipFallbackDisplayOfZeroAngles Same as in first overload. See there.
float fillDensity Same as in first overload. See there.
float minAngleDeg_withoutTextLineBreak Same as in first overload. See there.
float durationInSec Same as in first overload. See there.
bool hiddenByNearerObjects Same as in first overload. See there.


static void DrawBasics.CircleSegment(...);

Code snippet names: drawCircleSegment_relToQuatUp and drawCircleSegment_relToQuatUp_func.
Parameters:
Image Type Parameter Name Description
Vector3 centerOfCircle The center of the circle.
Quaternion orientation A quaterion that rotates the whole circle object. Quaternion*forward is the turn axis of the circle. Quaternion*up defines the direction from where the angles are measured.
float startAngleDegCC_relativeToUp The start angle (in degrees) of the circle segment, measured from Quaternion*up counterclockwise when looking along Quaternion*forward.
float endAngleDegCC_relativeToUp The end angle (in degrees) of the circle segment, measured from Quaternion*up counterclockwise when looking along Quaternion*forward.
float radius The radius of the drawn circle segment.
Color color Same as in first overload. See there.
string text Same as in first overload. See there.
float radiusPortionWhereDrawFillStarts Same as in first overload. See there.
bool skipFallbackDisplayOfZeroAngles Same as in first overload. See there.
float fillDensity Same as in first overload. See there.
float minAngleDeg_withoutTextLineBreak Same as in first overload. See there.
float durationInSec Same as in first overload. See there.
bool hiddenByNearerObjects Same as in first overload. See there.


static void DrawBasics.CircleSegment(...);

Code snippet names: drawCircleSegment_aroundRayAxis and drawCircleSegment_aroundRayAxis_func.
Parameters:
Image Type Parameter Name Description
Vector3 startPos The start position on the perimeter of the circle segment.
Ray turnAxis A ray acting as turn axis for the startPos. startPos is turned around this ray and thereby creates the circle segment.
float turnAngleDegCC The angle (in degrees) how far startPos is turned around turnAxis, counterclockwise when looking along the turnAxis-ray.
Color color Same as in first overload. See there.
string text Same as in first overload. See there.
float radiusPortionWhereDrawFillStarts Same as in first overload. See there.
bool skipFallbackDisplayOfZeroAngles Same as in first overload. See there.
float fillDensity Same as in first overload. See there.
float minAngleDeg_withoutTextLineBreak Same as in first overload. See there.
float durationInSec Same as in first overload. See there.
bool hiddenByNearerObjects Same as in first overload. See there.


static void DrawBasics.CircleSegment(...);

Code snippet names: drawCircleSegment_aroundVecAxis and drawCircleSegment_aroundVecAxis_func.
Parameters:
Image Type Parameter Name Description
Vector3 startPosOnPerimeter The start position on the perimeter of the circle segment.
Vector3 centerOfCircle A position on an imaginary turnAxis, around which startPosOnPerimeter will get turned and thereby creates the circle segment. [known issue: "centerOfCircle" is a misnomer. A better name would be "turnAxis_origin", since it doesn't have to lie on the circle]
Vector3 normalOfCircle The axis direction of the imaginary turnAxis that is mounted at centerOfCircle. startPos will be turned around this axis and thereby creates the drawn circle segment.
float turnAngleDegCC The angle (in degrees) how far startPosOnPerimeter is turned around normalOfCircle, counterclockwise when looking along the normalOfCircle.
Color color Same as in first overload. See there.
string text Same as in first overload. See there.
float radiusPortionWhereDrawFillStarts Same as in first overload. See there.
bool skipFallbackDisplayOfZeroAngles Same as in first overload. See there.
float fillDensity Same as in first overload. See there.
float minAngleDeg_withoutTextLineBreak Same as in first overload. See there.
float durationInSec Same as in first overload. See there.
bool hiddenByNearerObjects Same as in first overload. See there.