Draw XXL documentation


Draw Basics.VectorFrom(...);

Draws a vector that is mounted at a starting point (similarly to Unitys Ray).

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


static void DrawBasics.VectorFrom(...);

Code snippet names: drawVectorFrom and drawVectorFrom_func.

Parameters:
Type Parameter Name Description
Vector3 vectorStartPos The mounting point where the vector starts.
Vector3 vector
Color color
float lineWidth
string text
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.
bool pointerAtBothSides
bool flattenThickRoundLineIntoAmplitudePlane The amplitude plane is an imaginary plane into which a tag text protrudes vertically to the vector direction. See also the "customAmplitudeAndTextDir" parameter.
Vector3 customAmplitudeAndTextDir The default behaviour is that a global setting takes care of this, but for custom cases it can be explicitly set by this parameter.
bool addNormalizedMarkingText This adds a little visualizer ring at the position where the vector would have a length of 1.
float enlargeSmallTextToThisMinTextSize This only has effect if the "text" parameter is used. 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.
bool writeComponentValuesAsText
float endPlates_size The line can optinally have end position markers which are called "end plates" here. The styling of the end plates depends on the aforementioned "flattenThickRoundLineIntoAmplitudePlane" parameter. The size that is specified here is interpreted as relative to the line lenght or in absolute units according to the global end plates size interpretation setting. The global settings DrawBasics.disableEndPlates_atLineStart and DrawBasics.disableEndPlates_atLineEnd can be used to draw the plate only at one specific line end and leave the other end without plate.
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.