SquareSlot manipulation class. The SSquareSlot creation can be done by calling the static functions:
. More...

#include <SSquareSlot.h>

Inheritance diagram for SSquareSlot:

Public Slots
static Array	All (Number VisCrit)
	To get all the SComp in the document. More...

Array	Discretize (Number deflection, Number meanPointDistance)
	To convert the continuous feature 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 iPoint, Boolean CalcIn3D)
	Returns the distance between a point and the feature <0 if below/inside the feature >0 if above/outside the feature. More...

static Array	FromClick ()
	Launches a click interaction to select a 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...

Number	GetLength ()
	Returns the length. More...

Number	GetPerimeter ()
	Returns the perimeter of the feature. More...

Number	GetWidth ()
	Returns the width. More...

SVector	GetXDir ()

SVector	GetYDir ()

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)
	Constructs a new SSquareSlot by defining its data. More...

static SSquareSlot	New (SPoint FirstPt, SPoint SecondPt, SPoint ThirdPt)
	Constructs a new SSquareSlot by 3 points. More...

static SSquareSlot	New (SSquareSlot Other)
	Constructs an SSquareSlot by copying Other. More...

	SetLength (Number iLength)
	Setter for the length. More...

	SetWidth (Number iWidth)
	Setter for the width. More...

Number	SetXDir (SVector iNewXDir)
	Setter for the SSquareSlot X direction. More...

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

static String	toString ()
	Get the type of the variable. More...

Public Slots inherited from SFeature
static Array	All (Number VisCrit)
	To get all the SComp in the document. More...

Array	Compare (SCloud iMeasCloud, Number DistMax, Number MappingObject, Number maxCosAngle=-2)
	Calculates the distances between 2 components for further inspection purpose (color mapping) More...

static Array	FromBfcFile (String iFilePath)
	To load a .bfc file. More...

static Array	FromClick ()
	Launches a click interaction to select a 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...

SPoint	GetCenter ()

SVector	GetNormal ()

	SetCenter (SPoint iCenter)
	To set a new center to the SFeature. More...

	SetNormal (SVector Normal)
	To set a new normal to the SFeature. 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 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 ()
	Launches a click interaction to select a 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 ()
	The component containing folder's name. More...

String	GetName ()
	The component's name. More...

String	GetPath ()
	To get the full path of a comp in the tree. More...

	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...

Additional Inherited Members
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...

Detailed Description

SquareSlot manipulation class. The SSquareSlot creation can be done by calling the static functions:
.

New() to create your own empty SSquareSlot.
New() to copy an existing SSquareSlot.
New() to create a new SSquareSlot by defining its center, normal, X axis, length and width.

var center = SPoint.New(1, 1, 2);

var normal = SVector.New(0, 1, 0);

var dirX = SVector.New(0, 0, 1);

var length = 25;

var width = 12;

var emptySSquareSlot = SSquareSlot.New();

var mySSquareSlot = SSquareSlot.New(center, normal, dirX, length, width);

var mySSquareSlotCopy = SSquareSlot.New(mySSquareSlot);

Member Function Documentation

◆ All

static Array SSquareSlot::All ( Number VisCrit )

inlinestaticslot

To get all the SComp in the document.

Return values

Array all the SSquareSlot contained in the document

Parameters

[in]

VisCrit

Visible selection criteria

0 Keep if not visible
1 Keep if visible
2 (Default) Indifferent

◆ Discretize

Array SSquareSlot::Discretize	(	Number	deflection,
		Number	meanPointDistance
	)

slot

To convert the continuous feature 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.

Return values

Array.ErrorCode	The error code: 0: No error 1: An error occurred
Array.Multi	The discretized SMultiline

Parameters

[in]	deflection	max deviation between the ideal shape and the discretized element
[in]	meanPointDistance	Mean distance between points/vertices

◆ Distance

Number SSquareSlot::Distance	(	SPoint	iPoint,
		Boolean	CalcIn3D
	)

slot

Returns the distance between a point and the feature <0 if below/inside the feature >0 if above/outside the feature.

Parameters

[in]	iPoint	the point from which the distance to the feature has to be calculated
[in]	CalcIn3D	should we calculate the deviation in 3D

◆ FromClick

static Array SSquareSlot::FromClick ( )

inlinestaticslot

Launches a click interaction to select a SComp in the scene.

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

Return values

Array.ErrorCode	The error code 0: Success, the SComp is selected. 1: Nothing is selected. 2: The ESCape key has been pressed
Array.SquareSlot	the SSquareSlot selected

◆ FromName

static Array SSquareSlot::FromName ( String Name )

inlinestaticslot

Search all the component with the given name.

Return values

Array all the SSquareSlot with the given name

◆ FromSel

static Array SSquareSlot::FromSel ( )

inlinestaticslot

To get all the selected SComp.

Return values

Array all the SSquareSlot selected

◆ GetLength

Number SSquareSlot::GetLength ( )

slot

Returns the length.

◆ GetPerimeter

Number SSquareSlot::GetPerimeter ( )

slot

Returns the perimeter of the feature.

◆ GetWidth

Number SSquareSlot::GetWidth ( )

slot

Returns the width.

◆ GetXDir

SVector SSquareSlot::GetXDir ( )

slot

Returns: The SSquareSlot X direction

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

◆ GetYDir

SVector SSquareSlot::GetYDir ( )

slot

Returns: The SSquareSlot Y direction

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

◆ New [1/4]

static SSquareSlot SSquareSlot::New ( )

staticslot

Default constructor to create an empty new SSquareSlot.

◆ New [2/4]

static SSquareSlot SSquareSlot::New	(	SPoint	Center,
		SVector	Normal,
		SVector	XDir,
		Number	Length,
		Number	Width
	)

staticslot

Constructs a new SSquareSlot by defining its data.

Parameters

[in]	Center	The circle's center
[in]	Normal	The circle's normal
	XDir	Plane's X axis
	Length	Plane's length
	Width	Plane's width

◆ New [3/4]

static SSquareSlot SSquareSlot::New	(	SPoint	FirstPt,
		SPoint	SecondPt,
		SPoint	ThirdPt
	)

staticslot

Constructs 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

[in]	FirstPt	First point on the square slot
[in]	SecondPt	Second point on the square slot
[in]	ThirdPt	Third point on the square slot to define the width

◆ New [4/4]

static SSquareSlot SSquareSlot::New ( SSquareSlot Other )

staticslot

Constructs an SSquareSlot by copying Other.

◆ SetLength

SSquareSlot::SetLength ( Number iLength )

slot

Setter for the length.

◆ SetWidth

SSquareSlot::SetWidth ( Number iWidth )

slot

Setter for the width.

◆ SetXDir

Number SSquareSlot::SetXDir ( SVector iNewXDir )

slot

Setter for the SSquareSlot X direction.

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

Parameters

[in] iNewXDir The new vector to set for the X direction.

Return values

Array.ErrorCode

0 Success,
1 An error occurred.

◆ toString [1/2]

String SSquareSlot::toString ( )

slot

Get the type of the variable.

◆ toString [2/2]

static String SSquareSlot::toString ( )

staticslot

Get the type of the variable.

Public Slots

Additional Inherited Members

Detailed Description

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 [1/2]

◆ toString [2/2]