Draw XXL documentation


Draw Basics.RayWithAlternatingColors(...);

Draw a ray whose color alternates along the ray (somehow similar to a chess board pattern). A similar effect can also be achieved by using Ray() with a LineStyle of "alternatingColorStripes", but here are more parameters to style the pattern.

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


static void DrawBasics.RayWithAlternatingColors(...);

Code snippet names: drawRayWithAlternatingColors and drawRayWithAlternatingColors_func.

Parameters:
Type Parameter Name Description
Vector3 start The start position of the ray.
Vector3 direction The ray direction, mounted at start.
Color color1
Color color2
float width
float lengthOfStripes This may get rounded internally to prevent an explosive rise of drawn lines.
string text
float animationSpeed
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 flattenThickRoundLineIntoAmplitudePlane The amplitude plane is an imaginary plane that contains the line and into which a tag text or line styles protrudes vertically to the vector direction. See also the "customAmplitudeAndTextDir" parameter.
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 alphaFadeOutLength_0to1 With this parameter an effect can be created where the line does not end distincly at the line end position, but slowly fades out towards the line end position. The default value of 0 means that the effect is disabled.
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.
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.
bool skipPatternEnlargementForLongLines
bool skipPatternEnlargementForShortLines