Draw XXL documentation


Draw Engine Basics.RayLineExtendedScreenspace(...);

A ray similar to DrawScreenspace.Ray(), but extended to see where the ray lands, if it would be longer.

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 DrawEngineBasics.RayLineExtendedScreenspace(...);

Code snippet names: drawRayLineExtendedScreenspace and drawRayLineExtendedScreenspace_func.

Parameters:
Type Parameter Name Description
Vector2 rayOrigin Viewport space goes from lower-left (= 0,0) to upper-right (= 1,1).
Vector2 rayDirection
Color color
float width_relToViewportHeight
string text
bool interpretDirectionAsUnwarped Unwarped: as if the screens aspect ratio would be one (while "screen height" defines 1 unit)
float coneLength_relToViewportHeight
bool displayDistanceOutsideScreenBorder
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 DrawEngineBasics.RayLineExtendedScreenspace(...);

Code snippet names: drawRayLineExtendedScreenspace_cam and drawRayLineExtendedScreenspace_cam_func.

Parameters:
Type Parameter Name Description
Camera screenCamera This parameter is the only difference to the previous overload. It specifies the camera explicitly instead of relying on DefaultScreenspaceWindowForDrawing or defaultCameraForDrawing.
Vector2 rayOrigin
Vector2 rayDirection
Color color
float width_relToViewportHeight
string text
bool interpretDirectionAsUnwarped
float coneLength_relToViewportHeight
bool displayDistanceOutsideScreenBorder
float durationInSec