Allow to regroup SMultiline in a single SComp entity: a set of polylines. More...

Inheritance diagram for SSetMultiline:

Public Types
enum	ExternalContourOptionEnum { EXTERNAL_2D_CALCULATION = 0 , EXTERNAL_3D_CALCULATION = 1 }
	To know whether the external contour calculation should output a 2D Contour or a 3D Contour. More...

enum	SetMultilineRepresentationTypeEnum { SETMULTILINE_SEGMENTS = 0 , SETMULTILINE_VERTICES = 1 , SETMULTILINE_INSPECTION = 2 }
	The different representation types for SSetMultiline. More...

Public Types inherited from SComp
enum	VisibilityEnum { HIDDEN_ONLY = 0 , VISIBLE_ONLY = 1 , ANY_VISIBILITY = 2 }
	Visible criteria. More...

Public Member Functions
Array< SMultiline >	Explode ()
	Explode the SSetMultiline. This function will explode the set and will duplicate all the contained SMultiline. More...

Object	ExternalContour (ExternalContourOptionEnum calculationOption)
	Calculate the external contour of a SSetMultiline. The direction used to calculate the external contour is the best plane of the SSetMultiline. More...

Object	Save (string filePath, SMatrix coordinateSystemMatrix=SMatrix())
	Save the SSetMultiline into a file. More...

	SetLineWidth (number width)
	Set the thickness of the SSetMultiline. More...

	SetSetMultilineRepresentation (SetMultilineRepresentationTypeEnum representation)
	Modify the representation of the SSetMultiline. More...

	ShowName (boolean showName)
	Show or hide the name of the SSetMultiline in the scene. More...

	SSetMultiline ()
	Default constructor to create an empty new SSetMultiline. More...

	SSetMultiline (Array< SMultiline > theMultiTable)
	Construct a new SSetMultiline from a table of SMultiline. More...

string	toString ()
	Get the type of the variable. More...

Public Member Functions inherited from SComp
	AddToDoc ()
	Add the object to the document. More...

	ApplyTransformation (SMatrix matrix)
	Apply a geometric transformation to the current object by making a product with the given matrix. More...

Object	GetBoundingBox (SMatrix ucs=null)
	Calculate the bounding box of the object. More...

Object	GetColors ()
	Get the colors of the object. More...

string	GetFolderName ()
	Get the name of the folder containing the object. More...

string	GetName ()
	Return the object's name. More...

string	GetPath ()
	Return the full path of a SComp in the tree. More...

	Invert ()
	Invert the normal of the object. More...

boolean	IsInDoc ()
	Return if the object is in the document or not. More...

boolean	IsVisible ()
	Get the visibility of the object. More...

	MoveToGroup (string groupPath, boolean moveInsideTopParent=true)
	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 ()
	Remove the object from the document. More...

	SetClippable (boolean clipping)
	Set clippable or not. More...

	SetColors (number red, number green, number blue)
	Set the colors of the object. More...

	SetName (string objectName)
	Set the object's name. More...

	SetTransparency (number alpha)
	Set the transparency of the object. More...

	SetVisibility (boolean visible)
	Set the object to be visible, or not visible. More...

string	toString ()
	Get the type of the variable. More...

	Translate (SVector vector)
	Make a translation of the current object with an SVector. More...

Static Public Member Functions
static Array< SSetMultiline >	All (VisibilityEnum visCrit=SComp.ANY_VISIBILITY)
	Get all the SSetMultiline in the document. More...

static Object	FromClick ()
	Launch an interaction to select a SSetMultiline in the scene. More...

static Array< SSetMultiline >	FromName (string name)
	Search all the SSetMultiline with the given name. More...

static Array< SSetMultiline >	FromSel ()
	Get all the selected SSetMultiline. More...

static SSetMultiline	New ()
	Default constructor to create an empty new SSetMultiline. More...

static SSetMultiline	New (Array< SMultiline > theMultiTable)
	Construct a new SSetMultiline from a table of SMultiline. More...

Static Public Member Functions inherited from SComp
static Array< SComp >	All (VisibilityEnum visCrit=SComp.ANY_VISIBILITY)
	Get all the SComp in the document. More...

static Object	FromClick ()
	Launch an interaction to select a SComp in the scene. More...

static Array< SComp >	FromName (string name)
	Search all the SComp with the given name. More...

static Array< SComp >	FromSel ()
	Get all the selected SComp. More...

Detailed Description

Allow to regroup SMultiline in a single SComp entity: a set of polylines.

SSetMultine acts as a polyline group. It is helpful to apply common edition methods to a set of polylines at once.

Member Enumeration Documentation

◆ ExternalContourOptionEnum

enum SSetMultiline::ExternalContourOptionEnum

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

Enumerator
EXTERNAL_2D_CALCULATION	Calculate a 2D contour.
EXTERNAL_3D_CALCULATION	Calculate a 3D contour.

◆ SetMultilineRepresentationTypeEnum

enum SSetMultiline::SetMultilineRepresentationTypeEnum

The different representation types for SSetMultiline.

Enumerator
SETMULTILINE_SEGMENTS	By default, segments are displayed.
SETMULTILINE_VERTICES	Segments and vertices are displayed.
SETMULTILINE_INSPECTION	Only available with inspection information.

Constructor & Destructor Documentation

◆ SSetMultiline() [1/2]

SSetMultiline::SSetMultiline ( )

Default constructor to create an empty new SSetMultiline.

◆ SSetMultiline() [2/2]

SSetMultiline::SSetMultiline ( Array< SMultiline > theMultiTable )

Construct a new SSetMultiline from a table of SMultiline.

Parameters

theMultiTable (Array<SMultiline>) The table of SMultiline

Member Function Documentation

◆ All()

static Array< SSetMultiline > SSetMultiline::All ( VisibilityEnum visCrit = SComp.ANY_VISIBILITY )

static

Get all the SSetMultiline in the document.

Parameters

visCrit

(VisibilityEnum) Visible selection criteria

SComp.HIDDEN_ONLY: Keep if not visible
SComp.VISIBLE_ONLY: Keep if visible
SComp.ANY_VISIBILITY: Indifferent

Returns: (Array<SSetMultiline>) Array of all the SSetMultiline contained in the document, that fulfill the visibility criteria

◆ Explode()

Array< SMultiline > SSetMultiline::Explode ( )

Explode the SSetMultiline. This function will explode the set and will duplicate all the contained SMultiline.

Returns: (Array<SMultiline>) The exploded multilines

◆ ExternalContour()

Object SSetMultiline::ExternalContour ( ExternalContourOptionEnum calculationOption )

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

Parameters

calculationOption

(ExternalContourOptionEnum) To 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

Return values

ret.ErrorCode	(number) The error code 0: No error 1: An error occurred
ret.SetMulti	(SSetMultiline) The external contours

◆ FromClick()

static Object SSetMultiline::FromClick ( )

static

Launch an interaction to select a SSetMultiline in the scene.

Warning: This function will pause the script, and wait for user interaction

Return values

ret.ErrorCode	(number) The error code 0: No error, the SSetMultiline is selected. 1: Nothing is selected. 2: The ESCape key has been pressed
ret.SetMulti	(SSetMultiline) The selected SSetMultiline

◆ FromName()

static Array< SSetMultiline > SSetMultiline::FromName ( string name )

static

Search all the SSetMultiline with the given name.

Parameters

name	(string) The name to find

Returns: (Array<SSetMultiline>) All the SSetMultiline with the given name

◆ FromSel()

static Array< SSetMultiline > SSetMultiline::FromSel ( )

static

Get all the selected SSetMultiline.

Returns: (Array<SSetMultiline>) All the selected SSetMultiline

◆ New() [1/2]

static SSetMultiline SSetMultiline::New ( )

static

Default constructor to create an empty new SSetMultiline.

Returns: (SSetMultiline) The new SSetMultiline.

◆ New() [2/2]

static SSetMultiline SSetMultiline::New ( Array< SMultiline > theMultiTable )

static

Construct a new SSetMultiline from a table of SMultiline.

Parameters

theMultiTable (Array<SMultiline>) The table of SMultiline

Returns: (SSetMultiline) The new SSetMultiline.

◆ Save()

Object SSetMultiline::Save	(	string	filePath,
		SMatrix	coordinateSystemMatrix = `SMatrix()`
	)

Save the SSetMultiline into a file.

Parameters

filePath	(string) The complete file path to save into
coordinateSystemMatrix	(SMatrix) The matrix to define a UCS used for the export (or identity to use the WCS)

Return values

ret.ErrorCode

(number) The error code

0: No error
1: An error occurred

◆ SetLineWidth()

SSetMultiline::SetLineWidth ( number width )

Set the thickness of the SSetMultiline.

Note: The value must be upper than 0, else absolute value is used

Parameters

width (number) The width to set

◆ SetSetMultilineRepresentation()

SSetMultiline::SetSetMultilineRepresentation ( SetMultilineRepresentationTypeEnum representation )

Modify the representation of the SSetMultiline.

Parameters

representation

(SetMultilineRepresentationTypeEnum) The multiline representation type

SETMULTILINE_SEGMENTS: Display segments only
SETMULTILINE_VERTICES: Display segments and vertices
SETMULTILINE_INSPECTION: Display inspection information

◆ ShowName()

SSetMultiline::ShowName ( boolean showName )

Show or hide the name of the SSetMultiline in the scene.

Parameters

showName (boolean) The visibility state

◆ toString()

string SSetMultiline::toString ( )

Get the type of the variable.

Returns: (string) The type name

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Enumeration Documentation

◆ ExternalContourOptionEnum

◆ SetMultilineRepresentationTypeEnum

Constructor & Destructor Documentation

◆ SSetMultiline() [1/2]

◆ SSetMultiline() [2/2]

Member Function Documentation

◆ All()

◆ Explode()

◆ ExternalContour()

◆ FromClick()

◆ FromName()

◆ FromSel()

◆ New() [1/2]

◆ New() [2/2]

◆ Save()

◆ SetLineWidth()

◆ SetSetMultilineRepresentation()

◆ ShowName()

◆ toString()