set_scene_3d_label_paramT_set_scene_3d_label_paramSetScene3dLabelParamSetScene3dLabelParam (Operator)
Name
set_scene_3d_label_paramT_set_scene_3d_label_paramSetScene3dLabelParamSetScene3dLabelParam
— Setzen von Parametern eines Labels in einer 3D-Szene.
Signatur
void SetScene3dLabelParam(const HTuple& Scene3D, const HTuple& LabelIndex, const HTuple& GenParamName, const HTuple& GenParamValue)
void HScene3D::SetScene3dLabelParam(const HTuple& LabelIndex, const HString& GenParamName, const HTuple& GenParamValue) const
void HScene3D::SetScene3dLabelParam(Hlong LabelIndex, const HString& GenParamName, const HTuple& GenParamValue) const
void HScene3D::SetScene3dLabelParam(Hlong LabelIndex, const char* GenParamName, const HTuple& GenParamValue) const
void HScene3D::SetScene3dLabelParam(Hlong LabelIndex, const wchar_t* GenParamName, const HTuple& GenParamValue) const
(Nur Windows)
Beschreibung
set_scene_3d_label_paramset_scene_3d_label_paramSetScene3dLabelParamSetScene3dLabelParamSetScene3dLabelParam
setzt Parameter des Labels mit dem
Index LabelIndexLabelIndexLabelIndexLabelIndexlabelIndex
in der 3D-Szene Scene3DScene3DScene3DScene3Dscene3D
. Name
und Wert eines Parameters werden in GenParamNameGenParamNameGenParamNameGenParamNamegenParamName
und
GenParamValueGenParamValueGenParamValueGenParamValuegenParamValue
übergeben. Es ist möglich, ein Paar aus
GenParamNameGenParamNameGenParamNameGenParamNamegenParamName
und GenParamValueGenParamValueGenParamValueGenParamValuegenParamValue
für einzelne oder
mehrere Labels zu setzen.
Die folgenden Werte können gesetzt werden:
- 'reference_point'"reference_point""reference_point""reference_point""reference_point":
-
Koordinaten des Bezugspunkts als [X, Y, Z]-Koordinatentupel.
Um einen Bezugspunkt zu entfernen, kann auch ein leeres Tupel
übergeben werden. Das ist nur möglich wenn 'relates_to'"relates_to""relates_to""relates_to""relates_to"
auf 'window'"window""window""window""window" gesetzt ist.
- 'position'"position""position""position""position":
-
Position (fest oder relativ, abhängig von 'relates_to'"relates_to""relates_to""relates_to""relates_to")
des Labels. Entweder als [Row, Column]-Koordinaten oder eine
der folgenden vordefinierten Positionen:
'top_left'"top_left""top_left""top_left""top_left", 'top'"top""top""top""top", 'top_right'"top_right""top_right""top_right""top_right",
'left'"left""left""left""left", 'center'"center""center""center""center", 'right'"right""right""right""right",
'bottom_left'"bottom_left""bottom_left""bottom_left""bottom_left", 'bottom'"bottom""bottom""bottom""bottom" oder
'bottom_right'"bottom_right""bottom_right""bottom_right""bottom_right".
- 'relates_to'"relates_to""relates_to""relates_to""relates_to":
-
Art der Positionierung. Ist entweder 'window'"window""window""window""window"
(feste Positionierung in Fensterkoordinaten) oder 'point'"point""point""point""point"
(Positionierung relativ zum Bezugspunkt).
'relates_to'"relates_to""relates_to""relates_to""relates_to" kann nicht auf 'point'"point""point""point""point" gesetzt werden,
wenn der Bezugspunkt auf einen leeren Tupel gesetzt wurde.
Werte: 'window' or 'point'
- 'text'"text""text""text""text":
-
Text des Labels. Mehrere Zeilen werden mit
'\n'"\n""\n""\n""\n" getrennt.
- 'font'"font""font""font""font":
-
Schriftart des Textlabels.
Werte: Verfügbare Schriftarten können mit query_fontquery_fontQueryFontQueryFontQueryFont
abgefragt werden.
Defaultwert: Font des ersten Fensters, in dem die Szene dargestellt
wird. Ansonsten die Default-Systemschriftart.
- 'text_color'"text_color""text_color""text_color""text_color":
-
Farbe des Texts. Die verfügbaren Farben können mit dem
Operator query_colorquery_colorQueryColorQueryColorQueryColor
erfragt werden.
Darüberhinaus kann die Farbe auch über ein RGB-Tripel in der Form
'#rrggbb'"#rrggbb""#rrggbb""#rrggbb""#rrggbb" gesetzt werden, wobei 'rr', 'gg' und 'bb'
jeweils hexadezimale Zahlen zwischen '00' und 'ff' sind.
Werte: 'red', 'green', ...
Defaultwert: 'white'
- 'alpha'"alpha""alpha""alpha""alpha":
-
Transparenz des Labelhintergrunds.
Werte: Zahl zwischen 0.0 (voll transparent)
und 1.0 (voll opak).
Defaultwert: 1.0
- 'disp_background'"disp_background""disp_background""disp_background""disp_background":
-
Flag, ob der Hintergrund des Labels dargestellt wird.
Werte: 'true' or 'false'
Defaultwert: 'false'
- 'disp_connecting_line'"disp_connecting_line""disp_connecting_line""disp_connecting_line""disp_connecting_line":
-
Flag, ob die Verbindungslinie zwischen dem Label und dem
entsprechenden 3D-Punkt angezeigt werden soll.
Werte: 'true' or 'false'
Defaultwert: 'false'
- 'visible'"visible""visible""visible""visible":
-
Setzt die Sichtbarkeit des Labels. Wird 'visible'"visible""visible""visible""visible" auf
'if_point_is_visible'"if_point_is_visible""if_point_is_visible""if_point_is_visible""if_point_is_visible" gesetzt, ist das Label nur sichtbar,
wenn der Bezugspunkt sichtbar ist.
Im Kompatibilitätsmodus oder im Falle, dass kein Bezugspunkt
gesetzt ist, verhält sich 'if_point_is_visible'"if_point_is_visible""if_point_is_visible""if_point_is_visible""if_point_is_visible" wie
'true'"true""true""true""true".
Werte: 'true', 'false', 'if_point_is_visible'
Defaultwert: 'false'
Ausführungsinformationen
- Multithreading-Typ: reentrant (läuft parallel zu nicht-exklusiven Operatoren).
- Multithreading-Bereich: global (kann von jedem Thread aufgerufen werden).
- Wird ohne Parallelisierung verarbeitet.
Parameter
Scene3DScene3DScene3DScene3Dscene3D
(input_control) scene_3d →
HScene3D, HTupleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)
Handle der 3D-Szene.
LabelIndexLabelIndexLabelIndexLabelIndexlabelIndex
(input_control) integer(-array) →
HTupleHTupleHtuple (integer) (int / long) (Hlong) (Hlong)
Index des Textlabels.
GenParamNameGenParamNameGenParamNameGenParamNamegenParamName
(input_control) string →
HTupleHTupleHtuple (string) (string) (HString) (char*)
Namen der generischen Parameter.
Defaultwert:
'color'
"color"
"color"
"color"
"color"
Werteliste: 'color'"color""color""color""color", 'disp_background'"disp_background""disp_background""disp_background""disp_background", 'disp_connecting_line'"disp_connecting_line""disp_connecting_line""disp_connecting_line""disp_connecting_line", 'font'"font""font""font""font", 'position'"position""position""position""position", 'reference_point'"reference_point""reference_point""reference_point""reference_point", 'relates_to'"relates_to""relates_to""relates_to""relates_to", 'text'"text""text""text""text", 'text_color'"text_color""text_color""text_color""text_color", 'visibility'"visibility""visibility""visibility""visibility"
GenParamValueGenParamValueGenParamValueGenParamValuegenParamValue
(input_control) string-array →
HTupleHTupleHtuple (string / integer / real) (string / int / long / double) (HString / Hlong / double) (char* / Hlong / double)
Werte der generischen Parameter.
Defaultwert:
'red'
"red"
"red"
"red"
"red"
Werteliste: 'blue'"blue""blue""blue""blue", 'bottom'"bottom""bottom""bottom""bottom", 'bottom_left'"bottom_left""bottom_left""bottom_left""bottom_left", 'bottom_right'"bottom_right""bottom_right""bottom_right""bottom_right", 'center'"center""center""center""center", 'green'"green""green""green""green", 'left'"left""left""left""left", 'point'"point""point""point""point", 'red'"red""red""red""red", 'right'"right""right""right""right", 'top'"top""top""top""top", 'top_left'"top_left""top_left""top_left""top_left", 'top_right'"top_right""top_right""top_right""top_right", 'window'"window""window""window""window"
Ergebnis
Sind die Parameterwerte korrekt, dann liefert
set_scene_3d_label_paramset_scene_3d_label_paramSetScene3dLabelParamSetScene3dLabelParamSetScene3dLabelParam
den Wert 2 (H_MSG_TRUE). Gegebenenfalls wird eine
Fehlerbehandlung durchgeführt.
Vorgänger
add_scene_3d_labeladd_scene_3d_labelAddScene3dLabelAddScene3dLabelAddScene3dLabel
Modul
3D Metrology