Draw XXL documentation


Draw Screenspace.Point(...);

Draw a point marking cross onto the screen to highlight a specific screenspace position. The overloads have the same parameters and differ only in the order of the parameters. They can be chosen depending on what you want wo achieve. The first overload-pair emphasizes in merely making a position visible. The second overload-pair emphasizes on adding further information via a text tag.
See also PointTag.

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

Code snippet names: drawScreenPoint and drawScreenPoint_func.

Parameters:
Type Parameter Name Description
Vector2 position Viewport space goes from lower-left (= 0,0) to upper-right (= 1,1).
Color color
float sizeOfMarkingCross_relToViewportHeight
float zRotationDegCC
float markingCrossLinesWidth_relToViewportHeight
bool drawPointerIfOffscreen
string text
bool pointer_as_textAttachStyle
bool drawCoordsAsText
bool addTextForOutsideDistance_toOffscreenPointer
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.Point(...);

Code snippet names: drawScreenPoint_cam and drawScreenPoint_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 position
Color color
float sizeOfMarkingCross_relToViewportHeight
float zRotationDegCC
float markingCrossLinesWidth_relToViewportHeight
bool drawPointerIfOffscreen
string text
bool pointer_as_textAttachStyle
bool drawCoordsAsText
bool addTextForOutsideDistance_toOffscreenPointer
float durationInSec


static void DrawScreenspace.Point(...);

Code snippet names: drawScreenPoint_prioText and drawScreenPoint_prioText_func.

Parameters:
Type Parameter Name Description
Vector2 position Viewport space goes from lower-left (= 0,0) to upper-right (= 1,1).
string text
Color color
float sizeOfMarkingCross_relToViewportHeight
float markingCrossLinesWidth_relToViewportHeight
float zRotationDegCC
bool drawPointerIfOffscreen
bool pointer_as_textAttachStyle
bool drawCoordsAsText
bool addTextForOutsideDistance_toOffscreenPointer
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.Point(...);

Code snippet names: drawScreenPoint_prioText_cam and drawScreenPoint_prioText_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 position
string text
Color color
float sizeOfMarkingCross_relToViewportHeight
float markingCrossLinesWidth_relToViewportHeight
float zRotationDegCC
bool drawPointerIfOffscreen
bool pointer_as_textAttachStyle
bool drawCoordsAsText
bool addTextForOutsideDistance_toOffscreenPointer
float durationInSec