|
enum | SLabelBackgroundType {
NO_BACKGROUND
, SCENE_BACKGROUND_COLOR
, SPECIAL_COLOR
, TOLERANCE_COLOR
,
LastBackgroundType
} |
|
enum | SLabelCol {
Reference
, Measure
, Deviation
, TolMin
,
TolMax
, Note
, Flushing
, EmptyCol
,
Nominal
, BBoxMin
, BBoxMax
, Size
,
Centroid
, LowestPoint
, UppestPoint
, Count
,
UndefinedCol
, LastColType
} |
|
enum | SLabelLine {
XX
, YY
, ZZ
, NormalX
,
NormalY
, NormalZ
, Radius
, Diameter
,
Angle
, Circularity
, Cylindricity
, Planeity
,
Distance
, AngleX
, AngleY
, AngleZ
,
AngleCompX
, AngleCompY
, AngleCompZ
, AngleSuppX
,
AngleSuppY
, AngleSuppZ
, AngleC
, AngleS
,
Dev3D
, Curv
, EmptyLine
, Length
,
Width
, Linearity
, Sphericity
, DistanceXY
,
DistanceYZ
, DistanceXZ
, DistanceX
, DistanceY
,
DistanceZ
, Volume
, Intensity
, VolumeOver
,
VolumeUnder
, Perpendicularity
, Parallelism
, Level
,
Surface
, NbPoints
, NbTriangles
, NbPieces
,
NbFreeCont
, UndefinedLine
, Flatness
, LastLineType
} |
|
enum | SLabelType {
LONG
, MEDIUM
, SMALL
, MINIMUM
,
LastLabelType
} |
|
enum | RepresentationTypeEnum {
SMOOTH
, FLAT
, WIRE
, SMOOTH_WIRE
,
FLAT_WIRE
, SMOOTH_ROTWIRE
, FLAT_ROTWIRE
, TEXTURE
,
INSPECTION
} |
| The different representation types for inherited classes.
Use (inherited class).SMOOTH. Example: for a cloud, use SCloud.SMOOTH. More...
|
|
|
| AddSComp (Array< SComp > tblSComp) |
| To add some SComp to the label.
The label and the SComp will be one entity. More...
|
|
static Array | All (Number VisCrit) |
| To get all the SComp in the document. More...
|
|
| AttachToPoint (SPoint iAttachedPoint) |
| To attach the label to a 3D point in the scene. More...
|
|
static Array | FromClick () |
| Displays a dialog box to select an SComp in the scene. More...
|
|
static Array | FromName (String Name) |
| Search all the component with the given name. More...
|
|
static Array | FromSel () |
| To get all the selected SComp. More...
|
|
Array | GetCell (Number IdxLin, Number IdxCol) |
| To get the content of a cell. More...
|
|
Array | GetCol (Number IdxCol) |
| To get the content of all the column IdxCol. More...
|
|
Array | GetColByType (SLabelCol ColType) |
| To get the content of all the column by his type. More...
|
|
String | GetComment () |
|
Array | GetLine (Number IdxLin) |
| To get the content of all the line IdxLin. More...
|
|
Array | GetLineByType (SLabelLine LineType) |
| To get the content of all the Line by his type. More...
|
|
static SLabel | New (Number NbLin, Number NbCol) |
| Default constructor to create an empty new SLabel. More...
|
|
static SLabel | New (SLabel iOther) |
| Constructs an SLabel by copying the SLabel _iOther. More...
|
|
static | SetBackgroundColor (Number Red, Number Green, Number Blue, Number Transparency) |
| To define backGround color. More...
|
|
static | SetBackgroundType (SLabelBackgroundType BackgroundType) |
| To define background type
. More...
|
|
Array | SetCell (Number IdxLin, Number IdxCol, Number Value) |
| To set the content of a cell. More...
|
|
Array | SetCol (Number IdxCol, Array< Number > ValueTbl) |
| To set the content of all the column IdxCol. More...
|
|
Array | SetColType (Array< SLabelCol > ColType) |
| To set the type for all columns. More...
|
|
| SetComment (String Comment) |
| To set a comment to the label. More...
|
|
static | SetDecimalNumber (Number NbDecimal) |
| To define number of decimal to display. More...
|
|
Array | SetLine (Number IdxLin, Array< Number > ValueTbl) |
| To set the content of all the line IdxLin. More...
|
|
static | SetLineColor (Number Red, Number Green, Number Blue) |
| To define color of line contour and text. More...
|
|
Array | SetLineType (Array< SLabelLine > LineType) |
| To set the type for all lines. More...
|
|
static | SetSizeType (SLabelType LabelType) |
| To define how the label is visible. More...
|
|
| SetTolerance (Number LowTol, Number UpperTol) |
| To set the default tolerance. More...
|
|
Array | SetVisibleColumn (Number ColumnRowIndex, Boolean IsVisible) |
| To hide/show one column with a given index. More...
|
|
Array | SetVisibleRow (Number RowIndex, Boolean IsVisible) |
| To hide/show one row with a given index. More...
|
|
| ShowComment (Boolean iShowComment) |
| To show or hide the comment. More...
|
|
String | toString () |
| Get the type of the variable. More...
|
|
static String | toString () |
| Get the type of the variable. More...
|
|
static | UseEngineeringNotation (Boolean Use) |
| To define if labels use engineering notation ( Xe+y ) More...
|
|
| AddToDoc () |
| To add the object to the document. More...
|
|
static Array | All (Number VisCrit) |
| To get all the SComp in the document. More...
|
|
| ApplyTransformation (SMatrix iMatrix) |
| To apply a geometric transformation to the current object by making a product with the given matrix. More...
|
|
| Clear () |
| To deallocate object memory. More...
|
|
static Array | FromClick () |
| Displays a dialog box to select an SComp in the scene. More...
|
|
static Array | FromName (String Name) |
| Search all the component with the given name. More...
|
|
static Array | FromSel () |
| To get all the selected SComp. More...
|
|
Array | GetBoundingBox () |
| Calculates the bounding box of the component. More...
|
|
Array | GetColors () |
| To get the colors of the component. More...
|
|
String | GetFolderName () |
|
String | GetName () |
|
| Invert () |
| Normal of the component is inverted. More...
|
|
Boolean | IsInDoc () |
| Return if the component is in the document or not. More...
|
|
Boolean | IsVisible () |
|
| MoveToGroup (String GroupPath, Boolean MoveInsideTopParent) |
| Move the object to the document group represent by the given path. If some groups, in the path, don't exist, they will be created. More...
|
|
| RemoveFromDoc () |
| To remove the object from the document. More...
|
|
| SetClippable (Boolean clipping) |
| Set clippable or not. More...
|
|
| SetColors (Number Red, Number Green, Number Blue) |
| Sets the colors of the component. More...
|
|
| SetName (String ComponentName) |
| To set the component's name. More...
|
|
| SetRepresentationType (RepresentationTypeEnum Representation) |
| The shading type of the component is modified. More...
|
|
| SetTransparency (Number Alpha) |
| Sets the transparency of the component. More...
|
|
| SetVisibility (Boolean Visible) |
| Sets the component to be visible, or not visible. More...
|
|
String | toString () |
| Get the type of the variable. More...
|
|
String | toString () |
| Get the type of the variable. More...
|
|
| Translate (SVector Vector) |
| To make a translation of the current object with an SVector. More...
|
|
| Clear () |
| To deallocate memory of the object. More...
|
|
String | toString () |
| Get the type of the variable. More...
|
|
The SLabel class provides a labelling feature, to easily track your components on the scene. The SLabel creation can be done by calling the static functions:
.
- New() to copy an existing SLabel.
- New() to create your own empty SLabel with custom numbers of lines and columns.
var theLabel = SLabel.New(3, 2); // Custom SLabel creation
theLabel.AttachToPoint(SPoint.New()); // Attach to origin
theLabel.SetLineType(
[SLabel.XX, SLabel.YY, SLabel.ZZ] // [in] The line types
);
theLabel.SetColType(
[SLabel.Reference, SLabel.Measure] // [in] The column types
);
theLabel.SetCol(0, [1, 2, 3]); // Fill first column
theLabel.SetCol(1, [10, 20, 30]); // Fill second column
theLabel.SetComment("Sample");
theLabel.AddToDoc();