Cyclone 3DR Script
from Technodigit, part of Hexagon. Copyright 1997-2021.
SSetMultiline Class Reference

SSetMultiline class is a set of SMultiline, it will allow to regroup SMultiline in an SComp entity, so you can apply SComp functionality more easily.
The SSetMultiline creation can be done by calling the static functions:
. More...

Inheritance diagram for SSetMultiline:
SComp SObject

Public Types

enum  ExternalContourOptionEnum { EXTERNAL_2D_CALCULATION , EXTERNAL_3D_CALCULATION }
 To know whether the external contour calculation should output a 2D Contour or a 3D Contour. More...
 
enum  SetMultilineRepresentationTypeEnum { SETMULTILINE_SEGMENTS , SETMULTILINE_VERTICES , SETMULTILINE_INSPECTION }
 The different representation types for set of multilines.
Use SMultiline.FLAT. More...
 
- Public Types inherited from SComp
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...
 

Public Slots

static Array All (Number VisCrit)
 To get all the SComp in the document. More...
 
Array Explode ()
 To explode the set of SMultiline.
This function will explode the set and will duplicate all the contained SMultiline. More...
 
Array ExternalContour (ExternalContourOptionEnum CalculationOption)
 Calculates the external contour of a SSetMultiline
The direction used to calculate the External contour is the best plane of the SSetMultiline. 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...
 
static SSetMultiline New ()
 Default constructor to create an empty new SSetMultiline. More...
 
static SSetMultiline New (Array< SMultiline > TheMultiTable)
 Constructs a new SSetMultiline by defining its data. More...
 
Array Save (String FilePath, SMatrix CoordinateSystemMatrix={})
 Saves the SetMultiline into a file. More...
 
 SetLineWidth (Number width)
 Change the thickness of the lines. More...
 
 SetSetMultilineRepresentation (SetMultilineRepresentationTypeEnum Representation)
 The representation of the component is modified. More...
 
 ShowName (Boolean iShowName)
 Control whether the name of the multiline set is shown or not in the scene. More...
 
String toString ()
 Get the type of the variable. More...
 
static String toString ()
 Get the type of the variable. More...
 
- Public Slots inherited from SComp
 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 Matrix)
 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...
 
- Public Slots inherited from SObject
 Clear ()
 To deallocate memory of the object. More...
 
String toString ()
 Get the type of the variable. More...
 

Detailed Description

SSetMultiline class is a set of SMultiline, it will allow to regroup SMultiline in an SComp entity, so you can apply SComp functionality more easily.
The SSetMultiline creation can be done by calling the static functions:
.

Member Enumeration Documentation

◆ ExternalContourOptionEnum

To know whether the external contour calculation should output a 2D Contour or a 3D Contour.

Enumerator
EXTERNAL_2D_CALCULATION 
EXTERNAL_3D_CALCULATION 

◆ SetMultilineRepresentationTypeEnum

The different representation types for set of multilines.
Use SMultiline.FLAT.

Enumerator
SETMULTILINE_SEGMENTS 
SETMULTILINE_VERTICES 
SETMULTILINE_INSPECTION 

Member Function Documentation

◆ All

static Array SSetMultiline::All ( Number  VisCrit)
inlinestaticslot

To get all the SComp in the document.

Return values
Arrayall the SSetMultiline contained in the document
Parameters
[in]VisCritVisible selection criteria
  • 0 Keep if not visible
  • 1 Keep if visible
  • 2 (Default) Indifferent

◆ Explode

Array SSetMultiline::Explode ( )
slot

To explode the set of SMultiline.
This function will explode the set and will duplicate all the contained SMultiline.

Return values
Arraythe table of exploded SMultiline

◆ ExternalContour

Array SSetMultiline::ExternalContour ( ExternalContourOptionEnum  CalculationOption)
slot

Calculates the external contour of a SSetMultiline
The direction used to calculate the External contour is the best plane of the SSetMultiline.

Return values
Array.ErrorCodeThe error code:
  • 0 No error.
  • 1 An error occurred.
Array.SetMultithe set of polylines with the external contours (SSetMultiline).
Parameters
[in]CalculationOptionTo know whether the external contour calculation should output a 2D Contour or a 3D Contour EXTERNAL_2D_CALCULATION: Calculate a 2D contour EXTERNAL_3D_CALCULATION: Calculate a 3D contour

◆ FromClick

static Array SSetMultiline::FromClick ( )
inlinestaticslot

Displays a dialog box to select an SComp in the scene.

Warning
This function will break the script, and wait for user interaction
Return values
Array.ErrorCodeThe error code
  • 0: Success, the SComp is selected.
  • 1: Nothing is selected.
  • 2: The ESCape key has been pressed
Array.SetMultithe SSetMultiline selected

◆ FromName

static Array SSetMultiline::FromName ( String  Name)
inlinestaticslot

Search all the component with the given name.

Return values
Arrayall the SSetMultiline with the given name

◆ FromSel

static Array SSetMultiline::FromSel ( )
staticslot

To get all the selected SComp.

Return values
Arrayall the SSetMultiline selected

◆ New [1/2]

static SSetMultiline SSetMultiline::New ( )
staticslot

Default constructor to create an empty new SSetMultiline.

◆ New [2/2]

static SSetMultiline SSetMultiline::New ( Array< SMultiline TheMultiTable)
staticslot

Constructs a new SSetMultiline by defining its data.

Parameters
[in]TheMultiTableThe SMultiline table to attach to the object

◆ Save

Array SSetMultiline::Save ( String  FilePath,
SMatrix  CoordinateSystemMatrix = {} 
)
slot

Saves the SetMultiline into a file.

Supported extensions :

  • .igs : IGES format
Return values
Array.ErrorCodeThe error code.
  • 0 : No error.
  • 1 : An error occured.
Array.IsDemoVersionIndicates if this is a demonstration version or not
Parameters
FilePathThe complete file path to save into
CoordinateSystemMatrixthe matrix to define a UCS used for the export (or identity to use the WCS)

◆ SetLineWidth

SSetMultiline::SetLineWidth ( Number  width)
slot

Change the thickness of the lines.

Note
the value must upper to 0, else 1 is set
Parameters
widthThe width to set

◆ SetSetMultilineRepresentation

SSetMultiline::SetSetMultilineRepresentation ( SetMultilineRepresentationTypeEnum  Representation)
slot

The representation of the component is modified.

Parameters
[in]RepresentationThe multiline representation type

◆ ShowName

SSetMultiline::ShowName ( Boolean  iShowName)
slot

Control whether the name of the multiline set is shown or not in the scene.

Parameters
[in]iShowNamethe new visibility state of the multiline set

◆ toString [1/2]

String SSetMultiline::toString ( )
slot

Get the type of the variable.

◆ toString [2/2]

static String SSetMultiline::toString ( )
staticslot

Get the type of the variable.