SBLabel

Contents

SBLabel#

See also

SAMSON SDK: SBDDocumentLabel

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

Bases: SBNode

This class describes a label.

Overloaded function.

__init__(self: samson.SBLabel) -> None

Constructs a label.

__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#: Whether label is rendered on top of other geometry.

property drawOutline#: Whether label text is rendered with an outline.

property fontString#: The string representation of the font of the label.

property maximumDisplayRadius#: Maximum radius at which the label is displayed.

property minimumDisplayRadius#: Minimum radius at which the label is displayed.

property minimumLimitOfMaximumDisplayRadius#: Lower limit for maximumDisplayRadius.

property minimumLimitOfMinimumDisplayRadius#: Lower limit for minimumDisplayRadius.

property text#: The label’s text.