Draw XXL documentation


Draw Measurements.DistancePointToPlane(...);

This measures and draws the shortest possible distance between a point and a plane.
The function returns the measured distance.

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


static float DrawMeasurements.DistancePointToPlane(...);

Code snippet names: drawDistancePointToPlane_tr and drawDistancePointToPlane_tr_func.

Parameters:
Type Parameter Name Description
Vector3 point
Transform planeTransform A transform that specifies the position and orientation of the plane. Transform.up is the normal of the plane.
Color color The color of the distance display. The point and the plane are colored by the static global settings DrawMeasurements.defaultColor1 and DrawMeasurements.defaultColor2.
float linesWidth
string text
string planeName
float coneLength The length of the vector pointer cones. 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_forStraightVectors.
float enlargeSmallTextToThisMinTextSize The normal behaviour of text is that it scales with the line lenght. Though depending on the situation the line may get very small, up until the text is not readable anymore. This parameter sets a limit for the minimum text size. The text carrying line may get shorter and shorter but the text can stay visible.
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.DistancePointToPlane(...);

Code snippet names: drawDistancePointToPlane_pl and drawDistancePointToPlane_pl_func.

Parameters:
Type Parameter Name Description
Vector3 point
Plane plane The plane definition here is the only difference to the first overload.
Color color
float linesWidth
string text
string planeName
float coneLength
float enlargeSmallTextToThisMinTextSize
float durationInSec
bool hiddenByNearerObjects


static float DrawMeasurements.DistancePointToPlane(...);

Code snippet names: drawDistancePointToPlane_vec and drawDistancePointToPlane_vec_func.

Parameters:
Type Parameter Name Description
Vector3 point
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 planeName
float coneLength
float enlargeSmallTextToThisMinTextSize
float durationInSec
bool hiddenByNearerObjects