Draw XXL documentation


Draw Screenspace.Capsule(...);

Draws a capsule to the screen.

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

Code snippet names: drawScreenCapsule_3Dpos_vecC1C2Pos and drawScreenCapsule_3Dpos_vecC1C2Pos_func.

Parameters:
Type Parameter Name Description
Vector3 posOfCircle1_in3DWorldspace The world position will be projected onto the screen plane in order to get the final draw position.
Vector3 posOfCircle2_in3DWorldspace The world position will be projected onto the screen plane in order to get the final draw position.
float radius_relToViewportHeight
Color color
float linesWidth_relToViewportHeight
string text
bool drawPointerIfOffscreen
LineStyle lineStyle
float stylePatternScaleFactor
LineStyle fillStyle
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.Capsule(...);

Code snippet names: drawScreenCapsule_3Dpos_vecC1C2Pos_cam and drawScreenCapsule_3Dpos_vecC1C2Pos_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 posOfCircle1_in3DWorldspace
Vector3 posOfCircle2_in3DWorldspace
float radius_relToViewportHeight
Color color
float linesWidth_relToViewportHeight
string text
bool drawPointerIfOffscreen
LineStyle lineStyle
float stylePatternScaleFactor
LineStyle fillStyle
bool addTextForOutsideDistance_toOffscreenPointer
float durationInSec


static void DrawScreenspace.Capsule(...);

Code snippet names: drawScreenCapsule_2Dpos_vecC1C2Pos and drawScreenCapsule_2Dpos_vecC1C2Pos_func.

Parameters:
Type Parameter Name Description
Vector2 posOfCircle1_in2DViewportSpace Viewport space goes from lower-left (= 0,0) to upper-right (= 1,1).
Vector2 posOfCircle2_in2DViewportSpace Viewport space goes from lower-left (= 0,0) to upper-right (= 1,1).
float radius_relToViewportHeight
Color color
float linesWidth_relToViewportHeight
string text
bool drawPointerIfOffscreen
LineStyle lineStyle
float stylePatternScaleFactor
LineStyle fillStyle
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.Capsule(...);

Code snippet names: drawScreenCapsule_2Dpos_vecC1C2Pos_cam and drawScreenCapsule_2Dpos_vecC1C2Pos_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 posOfCircle1_in2DViewportSpace
Vector2 posOfCircle2_in2DViewportSpace
float radius_relToViewportHeight
Color color
float linesWidth_relToViewportHeight
string text
bool drawPointerIfOffscreen
LineStyle lineStyle
float stylePatternScaleFactor
LineStyle fillStyle
bool addTextForOutsideDistance_toOffscreenPointer
float durationInSec


static void DrawScreenspace.Capsule(...);

Code snippet names: drawScreenCapsule_rect and drawScreenCapsule_rect_func.

Parameters:
Type Parameter Name Description
Rect rect A hull rect that defines the size and position of the capsule.
Color color
CapsuleDirection2D capsuleDirection
float zRotationDegCC In degrees and counterclockwise (CC).
float linesWidth_relToViewportHeight
string text
bool drawPointerIfOffscreen
LineStyle lineStyle
float stylePatternScaleFactor
LineStyle fillStyle
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.Capsule(...);

Code snippet names: drawScreenCapsule_rect_cam and drawScreenCapsule_rect_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.
Rect rect
Color color
CapsuleDirection2D capsuleDirection
float zRotationDegCC
float linesWidth_relToViewportHeight
string text
bool drawPointerIfOffscreen
LineStyle lineStyle
float stylePatternScaleFactor
LineStyle fillStyle
bool addTextForOutsideDistance_toOffscreenPointer
float durationInSec


static void DrawScreenspace.Capsule(...);

Code snippet names: drawScreenCapsule_3Dpos_vecPosSize and drawScreenCapsule_3Dpos_vecPosSize_func.

Parameters:
Type Parameter Name Description
Vector3 centerPosition_in3DWorldspace The world position will be projected onto the screen plane in order to get the final draw position.
Vector2 size_relToViewportHeight
Color color
CapsuleDirection2D capsuleDirection
float zRotationDegCC In degrees and counterclockwise (CC).
float linesWidth_relToViewportHeight
string text
bool drawPointerIfOffscreen
LineStyle lineStyle
float stylePatternScaleFactor
LineStyle fillStyle
bool forceSizeInterpretationToWarpedViewportSpace
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.Capsule(...);

Code snippet names: drawScreenCapsule_3Dpos_vecPosSize_cam and drawScreenCapsule_3Dpos_vecPosSize_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 centerPosition_in3DWorldspace
Vector2 size_relToViewportHeight
Color color
CapsuleDirection2D capsuleDirection
float zRotationDegCC
float linesWidth_relToViewportHeight
string text
bool drawPointerIfOffscreen
LineStyle lineStyle
float stylePatternScaleFactor
LineStyle fillStyle
bool forceSizeInterpretationToWarpedViewportSpace
bool addTextForOutsideDistance_toOffscreenPointer
float durationInSec


static void DrawScreenspace.Capsule(...);

Code snippet names: drawScreenCapsule_2Dpos_vecPosSize and drawScreenCapsule_2Dpos_vecPosSize_func.

Parameters:
Type Parameter Name Description
Vector2 centerPosition_in2DViewportSpace Viewport space goes from lower-left (= 0,0) to upper-right (= 1,1).
Vector2 size_relToViewportHeight
Color color
CapsuleDirection2D capsuleDirection
float zRotationDegCC In degrees and counterclockwise (CC).
float linesWidth_relToViewportHeight
string text
bool drawPointerIfOffscreen
LineStyle lineStyle
float stylePatternScaleFactor
LineStyle fillStyle
bool forceSizeInterpretationToWarpedViewportSpace
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.Capsule(...);

Code snippet names: drawScreenCapsule_2Dpos_vecPosSize_cam and drawScreenCapsule_2Dpos_vecPosSize_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 centerPosition_in2DViewportSpace
Vector2 size_relToViewportHeight
Color color
CapsuleDirection2D capsuleDirection
float zRotationDegCC
float linesWidth_relToViewportHeight
string text
bool drawPointerIfOffscreen
LineStyle lineStyle
float stylePatternScaleFactor
LineStyle fillStyle
bool forceSizeInterpretationToWarpedViewportSpace
bool addTextForOutsideDistance_toOffscreenPointer
float durationInSec