Draw XXL documentation


Draw Screenspace.PointTag(...);

Similar to Point this highlights a world position, but here only the label tag is drawn. (no cross and no coordinate display at the labelled position.)

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

Code snippet names: drawScreenPointTag_3Dpos and drawScreenPointTag_3Dpos_func.

Parameters:
Type Parameter Name Description
Vector3 position_in3DWorldspace The world position will be projected onto the screen plane in order to get the final draw position.
string text
string titleText
Color color
bool drawPointerIfOffscreen
float linesWidth_relToViewportHeight
float size_asTextOffsetDistance_relToViewportHeight
Vector2 textOffsetDirection
float textSizeScaleFactor
bool skipConeDrawing
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.
Vector2 customTowardsPoint_ofDefaultTextOffsetDirection


static void DrawScreenspace.PointTag(...);

Code snippet names: drawScreenPointTag_3Dpos_cam and drawScreenPointTag_3Dpos_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.
Vector3 position_in3DWorldspace
string text
string titleText
Color color
bool drawPointerIfOffscreen
float linesWidth_relToViewportHeight
float size_asTextOffsetDistance_relToViewportHeight
Vector2 textOffsetDirection
float textSizeScaleFactor
bool skipConeDrawing
bool addTextForOutsideDistance_toOffscreenPointer
float durationInSec
Vector2 customTowardsPoint_ofDefaultTextOffsetDirection


static void DrawScreenspace.PointTag(...);

Code snippet names: drawScreenPointTag_2Dpos and drawScreenPointTag_2Dpos_func.

Parameters:
Type Parameter Name Description
Vector2 position_in2DViewportSpace Viewport space goes from lower-left (= 0,0) to upper-right (= 1,1).
string text
string titleText
Color color
bool drawPointerIfOffscreen
float linesWidth_relToViewportHeight
float size_asTextOffsetDistance_relToViewportHeight
Vector2 textOffsetDirection
float textSizeScaleFactor
bool skipConeDrawing
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.
Vector2 customTowardsPoint_ofDefaultTextOffsetDirection


static void DrawScreenspace.PointTag(...);

Code snippet names: drawScreenPointTag_2Dpos_cam and drawScreenPointTag_2Dpos_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_in2DViewportSpace
string text
string titleText
Color color
bool drawPointerIfOffscreen
float linesWidth_relToViewportHeight
float size_asTextOffsetDistance_relToViewportHeight
Vector2 textOffsetDirection
float textSizeScaleFactor
bool skipConeDrawing
bool addTextForOutsideDistance_toOffscreenPointer
float durationInSec
Vector2 customTowardsPoint_ofDefaultTextOffsetDirection