Provide square slot edition and creation methods. More...

Inheritance diagram for SSquareSlot:

Public Member Functions
Object	Discretize (number deflection=0, number meanPointDistance=0)
	Convert the square slot into a discretized SMultiline.Only one of the parameters must be specified at a time. To use the deflection, set a positive value and set 0 to meanPointDistance.To use the mean distance between points, set a positive value and set 0 to deflection. More...

number	Distance (SPoint point, boolean calcIn3D=true)
	Return the distance between a point and the square slot. More...

number	GetLength ()
	Return the length of the square slot. More...

number	GetPerimeter ()
	Return the perimeter of the square slot. More...

number	GetWidth ()
	Return the width of the square slot. More...

SVector	GetXDir ()
	Return the square slot X direction. More...

SVector	GetYDir ()
	Return the square slot Y direction. More...

	SetLength (number length)
	Set the length. More...

	SetWidth (number width)
	Set the width. More...

number	SetXDir (SVector newXDir)
	Set the X direction. More...

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

	SSquareSlot (SPoint center, SVector normal, SVector xDir, number length, number width)
	Construct a new SSquareSlot from a given center, normal, x direction, length and width. More...

	SSquareSlot (SPoint firstPt, SPoint secondPt, SPoint thirdPt)
	Construct a new SSquareSlot by 3 points. More...

	SSquareSlot (SSquareSlot other)
	Construct a SSquareSlot by copying another SSquareSlot. More...

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

Public Member Functions inherited from SFeature
Object	Compare (SCloud measCloud, number distMax, number mappingObject=1, number maxCosAngle=-2)
	Calculate the distances between 2 components for further inspection purpose (color mapping) More...

SPoint	GetCenter ()
	Return the center of the feature. More...

SVector	GetNormal ()
	Return the normal of the feature. More...

	SetCenter (SPoint center)
	Set the center. More...

	SetNormal (SVector normal)
	Set the normal. 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 ()
	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< SSquareSlot >	All (VisibilityEnum visCrit=SComp.ANY_VISIBILITY)
	Get all the SSquareSlot in the document. More...

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

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

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

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

static SSquareSlot	New (SPoint center, SVector normal, SVector xDir, number length, number width)
	Construct a new SSquareSlot from a given center, normal, x direction, length and width. More...

static SSquareSlot	New (SPoint firstPt, SPoint secondPt, SPoint thirdPt)
	Construct a new SSquareSlot by 3 points. More...

static SSquareSlot	New (SSquareSlot other)
	Construct a SSquareSlot by copying another SSquareSlot. More...

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

static Object	FromBfcFile (string filePath)
	Load a .bfc file. More...

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

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

static Array< SFeature >	FromSel ()
	Get all the selected SFeature. 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...

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

Detailed Description

Provide square slot edition and creation methods.

Constructor & Destructor Documentation

◆ SSquareSlot() [1/4]

SSquareSlot::SSquareSlot ( )

Default constructor to create an empty new SSquareSlot.

◆ SSquareSlot() [2/4]

SSquareSlot::SSquareSlot ( SSquareSlot other )

Construct a SSquareSlot by copying another SSquareSlot.

Parameters

other (SSquareSlot) The SSquareSlot to copy

◆ SSquareSlot() [3/4]

SSquareSlot::SSquareSlot	(	SPoint	center,
		SVector	normal,
		SVector	xDir,
		number	length,
		number	width
	)

Construct a new SSquareSlot from a given center, normal, x direction, length and width.

Parameters

center	(SPoint) Square slot center
normal	(SVector) Square slot normal
xDir	(SVector) Square slot axis
length	(number) Square slot length
width	(number) Square slot width

◆ SSquareSlot() [4/4]

SSquareSlot::SSquareSlot	(	SPoint	firstPt,
		SPoint	secondPt,
		SPoint	thirdPt
	)

Construct a new SSquareSlot by 3 points.

Note: The 3 points must be not identical.If you want to construct a square slot with more than 3 points, use SCloud.BestSqSlot().The two first points define the length and the number axis. The third defines the width.

Parameters

firstPt	(SPoint) First point on the square slot
secondPt	(SPoint) Second point on the square slot
thirdPt	(SPoint) Third point on the square slot to define the width

Member Function Documentation

◆ All()

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

static

Get all the SSquareSlot 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<SSquareSlot>) Array of all the SSquareSlot contained in the document, that fulfill the visibility criteria

◆ Discretize()

Object SSquareSlot::Discretize	(	number	deflection = `0`,
		number	meanPointDistance = `0`
	)

Convert the square slot into a discretized SMultiline.Only one of the parameters must be specified at a time. To use the deflection, set a positive value and set 0 to meanPointDistance.To use the mean distance between points, set a positive value and set 0 to deflection.

Parameters

deflection	(number) Max deviation between the ideal shape and the discretized element
meanPointDistance	(number) Mean distance between points/vertices

Return values

ret.ErrorCode	(number) The error code 0: No error 1: An error occurred
ret.Multi	(SMultiline) The discretized SMultiline

◆ Distance()

number SSquareSlot::Distance	(	SPoint	point,
		boolean	calcIn3D = `true`
	)

Return the distance between a point and the square slot.

Parameters

point	(SPoint) the point from which the distance to the feature has to be calculated
calcIn3D	(boolean) Should we calculate the deviation in 3D? true: Calculate in 3D false: Calculate in 2D

Return values

<0	Below/inside the feature
>0	Above/outside the feature

◆ FromClick()

static Object SSquareSlot::FromClick ( )

static

Launch an interaction to select a SSquareSlot 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 SSquareSlot is selected. 1: Nothing is selected. 2: The ESCape key has been pressed
ret.SquareSlot	(SSquareSlot) The selected SSquareSlot

◆ FromName()

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

static

Search all the SSquareSlot with the given name.

Parameters

name	(string) The name to find

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

◆ FromSel()

static Array< SSquareSlot > SSquareSlot::FromSel ( )

static

Get all the selected SSquareSlot.

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

◆ GetLength()

number SSquareSlot::GetLength ( )

Return the length of the square slot.

Returns: (number) The length of the square slot

◆ GetPerimeter()

number SSquareSlot::GetPerimeter ( )

Return the perimeter of the square slot.

Returns: (number) The perimeter of the square slot

◆ GetWidth()

number SSquareSlot::GetWidth ( )

Return the width of the square slot.

Returns: (number) The width of the square slot

◆ GetXDir()

SVector SSquareSlot::GetXDir ( )

Return the square slot X direction.

Warning: This vector can be null. Check it with SVector.IsNull()

Returns: (SVector) The square slot X direction

◆ GetYDir()

SVector SSquareSlot::GetYDir ( )

Return the square slot Y direction.

Warning: This vector can be null. Check it with SVector.IsNull()

Returns: (SVector) The square slot Y direction

◆ New() [1/4]

static SSquareSlot SSquareSlot::New ( )

static

Default constructor to create an empty new SSquareSlot.

Returns: (SSquareSlot) The new SSquareSlot.

◆ New() [2/4]

static SSquareSlot SSquareSlot::New	(	SPoint	center,
		SVector	normal,
		SVector	xDir,
		number	length,
		number	width
	)

static

Construct a new SSquareSlot from a given center, normal, x direction, length and width.

Parameters

center	(SPoint) Square slot center
normal	(SVector) Square slot normal
xDir	(SVector) Square slot axis
length	(number) Square slot length
width	(number) Square slot width

Returns: (SSquareSlot) The new SSquareSlot.

◆ New() [3/4]

static SSquareSlot SSquareSlot::New	(	SPoint	firstPt,
		SPoint	secondPt,
		SPoint	thirdPt
	)

static

Construct a new SSquareSlot by 3 points.

Note: The 3 points must be not identical.If you want to construct a square slot with more than 3 points, use SCloud.BestSqSlot().The two first points define the length and the number axis. The third defines the width.

Parameters

firstPt	(SPoint) First point on the square slot
secondPt	(SPoint) Second point on the square slot
thirdPt	(SPoint) Third point on the square slot to define the width

Returns: (SSquareSlot) The new SSquareSlot.

◆ New() [4/4]

static SSquareSlot SSquareSlot::New ( SSquareSlot other )

static

Construct a SSquareSlot by copying another SSquareSlot.

Parameters

other (SSquareSlot) The SSquareSlot to copy

Returns: (SSquareSlot) The new SSquareSlot.

◆ SetLength()

SSquareSlot::SetLength ( number length )

Set the length.

Parameters

length (number) The length to set

◆ SetWidth()

SSquareSlot::SetWidth ( number width )

Set the width.

Parameters

width (number) The width to set

◆ SetXDir()

number SSquareSlot::SetXDir ( SVector newXDir )

Set the X direction.

Note: The new X direction must be perpendicular to the Z direction

Parameters

newXDir (SVector) The vector to set

Return values

0	No error
1	An error occurred

◆ toString()

string SSquareSlot::toString ( )

Get the type of the variable.

Returns: (string) The type name

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SSquareSlot() [1/4]

◆ SSquareSlot() [2/4]

◆ SSquareSlot() [3/4]

◆ SSquareSlot() [4/4]

Member Function Documentation

◆ All()

◆ Discretize()

◆ Distance()

◆ FromClick()

◆ FromName()

◆ FromSel()

◆ GetLength()

◆ GetPerimeter()

◆ GetWidth()

◆ GetXDir()

◆ GetYDir()

◆ New() [1/4]

◆ New() [2/4]

◆ New() [3/4]

◆ New() [4/4]

◆ SetLength()

◆ SetWidth()

◆ SetXDir()

◆ toString()