SBLabel#

See also

SAMSON SDK: SBDDocumentLabel

class samson.SBLabel(*args, **kwargs)#

Bases: SBNode

This class describes a label.

Overloaded function.

  1. __init__(self: samson.SBLabel) -> None

Constructs a label.

  1. __init__(self: samson.SBLabel, name: str) -> None

Constructs a label with the given name.

getNextLabel(self: samson.SBLabel) samson.SBLabel#

Returns the next Label.

getPosition(self: samson.SBLabel) samson.SBPhysicalVector3#

Returns the position of the label

getPreviousLabel(self: samson.SBLabel) samson.SBLabel#

Returns the previous Label.

getViewportOffset(self: samson.SBLabel) samson.SBPhysicalVector3#

Returns the viewport offset on the position of the label

setViewportOffset(self: samson.SBLabel, arg0: samson.SBPhysicalVector3) None#

Sets the viewport offset on the position of the label

updateText(self: samson.SBLabel) None#

Updates the label’s text.

property drawOnTop#
property drawOutline#
property fontString#

The string representation of the font of the label.

property maximumDisplayRadius#
property minimumDisplayRadius#
property minimumLimitOfMaximumDisplayRadius#
property minimumLimitOfMinimumDisplayRadius#
property text#

The label’s text.