Draw XXL documentation


Draw Measurements.AngleLineToPlane(...);

This measures and draws the angle between a line and a plane.
The function returns the measured angle, depending on the "displayAndReturn_radInsteadOfDeg" parameter in degrees or radians.

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


static float DrawMeasurements.AngleLineToPlane(...);

Code snippet names: drawAngleLineToPlane_ray_tr and drawAngleLineToPlane_ray_tr_func.

Parameters:
Type Parameter Name Description
Ray line
Transform planeTransform A transform that defines the position and orientation of the plane. Transform.up is the normal of the plane.
Color color The color of the angle display. The line and plane are colored by the static global settings DrawMeasurements.defaultColor1 and DrawMeasurements.defaultColor2.
float linesWidth
string text
string lineName
string planeName
bool returnObtuseAngleOver90deg The line and the plane always span two vectors: One acute angle below 90° and one obtuse angle between 90° and 180°. Use this bool to specify which one you are interested in.
bool displayAndReturn_radInsteadOfDeg Default is "false", which means: using degrees.
float coneLength The parameter can be interpreted in different ways: It can be meant as absolute length or relative to the radius. The used interpretation is decided by the global setting coneLength_interpretation_forCircledVectors. The default interpretation is "relative to radius".
bool addTextForAlternativeAngleUnit "deg" and "rad" are two different angle units. They can be displayed both or only one of them. See also the "displayAndReturn_radInsteadOfDeg" parameter.
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 float DrawMeasurements.AngleLineToPlane(...);

Code snippet names: drawAngleLineToPlane_ray_pl and drawAngleLineToPlane_ray_pl_func.

Parameters:
Type Parameter Name Description
Ray line
Plane plane The plane definition here is the only difference to the first overload.
Color color
float linesWidth
string text
string lineName
string planeName
bool returnObtuseAngleOver90deg
bool displayAndReturn_radInsteadOfDeg
float coneLength
bool addTextForAlternativeAngleUnit
float durationInSec
bool hiddenByNearerObjects


static float DrawMeasurements.AngleLineToPlane(...);

Code snippet names: drawAngleLineToPlane_ray_vec and drawAngleLineToPlane_ray_vec_func.

Parameters:
Type Parameter Name Description
Ray line
Vector3 planeOrigin The plane definition here is the only difference to the first overload.
Vector3 planeNormal The plane definition here is the only difference to the first overload.
Color color
float linesWidth
string text
string lineName
string planeName
bool returnObtuseAngleOver90deg
bool displayAndReturn_radInsteadOfDeg
float coneLength
bool addTextForAlternativeAngleUnit
float durationInSec
bool hiddenByNearerObjects


static float DrawMeasurements.AngleLineToPlane(...);

Code snippet names: drawAngleLineToPlane_vec_tr and drawAngleLineToPlane_vec_tr_func.

Parameters:
Type Parameter Name Description
Vector3 lineOrigin The line definition here is the only difference to the first overload.
Vector3 lineDirection The line definition here is the only difference to the first overload.
Transform planeTransform
Color color
float linesWidth
string text
string lineName
string planeName
bool returnObtuseAngleOver90deg
bool displayAndReturn_radInsteadOfDeg
float coneLength
bool addTextForAlternativeAngleUnit
float durationInSec
bool hiddenByNearerObjects


static float DrawMeasurements.AngleLineToPlane(...);

Code snippet names: drawAngleLineToPlane_vec_pl and drawAngleLineToPlane_vec_pl_func.

Parameters:
Type Parameter Name Description
Vector3 lineOrigin The line and plane definition here is the only difference to the first overload.
Vector3 lineDirection The line and plane definition here is the only difference to the first overload.
Plane plane The line and plane definition here is the only difference to the first overload.
Color color
float linesWidth
string text
string lineName
string planeName
bool returnObtuseAngleOver90deg
bool displayAndReturn_radInsteadOfDeg
float coneLength
bool addTextForAlternativeAngleUnit
float durationInSec
bool hiddenByNearerObjects


static float DrawMeasurements.AngleLineToPlane(...);

Code snippet names: drawAngleLineToPlane_vec_vec and drawAngleLineToPlane_vec_vec_func.

Parameters:
Type Parameter Name Description
Vector3 lineOrigin The line and plane definition here is the only difference to the first overload.
Vector3 lineDirection The line and plane definition here is the only difference to the first overload.
Vector3 planeOrigin The line and plane definition here is the only difference to the first overload.
Vector3 planeNormal The line and plane definition here is the only difference to the first overload.
Color color
float linesWidth
string text
string lineName
string planeName
bool returnObtuseAngleOver90deg
bool displayAndReturn_radInsteadOfDeg
float coneLength
bool addTextForAlternativeAngleUnit
float durationInSec
bool hiddenByNearerObjects