IC8 Python API:RLPy RViewportLabel
Contents
- 1 Description
- 2 Constructor & Destructor
- 3 Member Functions
- 3.1 GetAnchor (self)
- 3.2 GetImageHeight (self)
- 3.3 GetImagePath (self)
- 3.4 GetImageWidth (self)
- 3.5 GetMesh (self)
- 3.6 GetText (self)
- 3.7 GetTextGap (self)
- 3.8 GetTextStyle (self)
- 3.9 GetVertexIndex (self)
- 3.10 GetWorldPosition (self)
- 3.11 SetImageHeight (self, nImageHeight)
- 3.12 SetImagePath (self, strImagePath)
- 3.13 SetImageWidth (self, nImageWidth)
- 3.14 SetMeshVertexAnchor (self, spMesh, nVertexIndex)
- 3.15 SetText (self, strText)
- 3.16 SetTextGap (self, fTextGap)
- 3.17 SetTextStyle (self, kTextStyle)
- 3.18 SetWorldAnchor (self, vWorldPosition)
- 4 Properties
Description
This class represents a viewport label with text or an image anchored to a world position or mesh vertex.
Constructor & Destructor
__init__ (self)
Initializes a new viewport label instance.
Member Functions
GetAnchor (self)
Returns the anchor mode used to position this viewport label.
GetImageHeight (self)
Returns the image height.
GetImagePath (self)
Returns the image path.
GetImageWidth (self)
Returns the image width.
GetMesh (self)
Returns the mesh used as the anchor for this viewport label.
GetText (self)
Returns the text.
GetTextGap (self)
Returns the text gap.
GetTextStyle (self)
Returns the text style configured for this viewport label.
GetVertexIndex (self)
Returns the mesh vertex index used by this viewport label.
GetWorldPosition (self)
Returns the world-space position used by this viewport label.
SetImageHeight (self, nImageHeight)
Sets the image height.
Parameters
- nImageHeight
SetImagePath (self, strImagePath)
Sets the image path.
Parameters
- strImagePath
SetImageWidth (self, nImageWidth)
Sets the image width.
Parameters
- nImageWidth
SetMeshVertexAnchor (self, spMesh, nVertexIndex)
Sets the label anchor to a mesh vertex.
Parameters
- spMesh
- nVertexIndex
SetText (self, strText)
Sets the text.
Parameters
- strText
SetTextGap (self, fTextGap)
Sets the text gap.
Parameters
- fTextGap
SetTextStyle (self, kTextStyle)
Sets the text style for this viewport label.
Parameters
- kTextStyle
SetWorldAnchor (self, vWorldPosition)
Sets the label anchor to a world-space position.
Parameters
- vWorldPosition
Properties
imageHeight
Height of the image displayed by the viewport label.
imagePath
Path of the image displayed by the viewport label.
imageWidth
Width of the image displayed by the viewport label.
text
Text displayed by the viewport label.
textGap
Spacing value used for the label text.
textStyle
Text-style overrides used by the viewport label.
thisown
Indicates whether this SWIG proxy owns the underlying C++ object.
