Draw XXL documentation


Draw Screenspace.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.

The camera which defines the screenspace can be appointed in several ways. One option is: Every function has an overload that is identical except that it takes a Camera as first parameter. Another more convenient option is: If no Camera is supplied then Draw XXL automatically searches for one according to the global DefaultScreenspaceWindowForDrawing setting (which can point to a Gameview camera or a Sceneview camera). Moreover there is the option to apoint a camera once to the global defaultCameraForDrawing field, which also has the effect that no camera has to be supplied as parameter to the actual draw functions.

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


static void DrawScreenspace.RayWithAlternatingColors(...);

Code snippet names: drawScreenRayWithAlternatingColors and drawScreenRayWithAlternatingColors_func.

Parameters:
Type Parameter Name Description
Vector2 start Viewport space goes from lower-left (= 0,0) to upper-right (= 1,1).
Vector2 direction
Color color1
Color color2
float lineWidth_relToViewportHeight
float lengthOfStripes_relToViewportHeight
string text
bool interpretDirectionAsUnwarped Unwarped: as if the screens aspect ratio would be one (while "screen height" defines 1 unit)
float animationSpeed
float endPlatesSize_relToViewportHeight
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 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.


static void DrawScreenspace.RayWithAlternatingColors(...);

Code snippet names: drawScreenRayWithAlternatingColors_cam and drawScreenRayWithAlternatingColors_cam_func.

Parameters:
Type Parameter Name Description
Camera targetCamera This parameter is the only difference to the previous overload. It specifies the camera explicitly instead of relying on DefaultScreenspaceWindowForDrawing or defaultCameraForDrawing.
Vector2 start
Vector2 direction
Color color1
Color color2
float lineWidth_relToViewportHeight
float lengthOfStripes_relToViewportHeight
string text
bool interpretDirectionAsUnwarped
float animationSpeed
float endPlatesSize_relToViewportHeight
float alphaFadeOutLength_0to1
float durationInSec