Provide cylinder edition and creation methods. More...

Inheritance diagram for SCylinder:

Public Member Functions
Object	Discretize (number deflection=0, number meanPointDistance=0)
	Convert the cylinder into a discretized SPoly. Only one parameter 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)
	Return the distance between a point and the cylinder. More...

SPoint	GetBaseCenter ()
	Return the base center of the cylinder. More...

SCircle	GetBaseCircle ()
	Return the base circle of the cylinder. More...

number	GetLength ()
	Return the length of the cylinder. More...

number	GetRadius ()
	Return the radius of the cylinder. More...

number	GetSurface ()
	Return the surface of the cylinder. More...

SPoint	GetTopCenter ()
	Return the top center of the cylinder. More...

SCircle	GetTopCircle ()
	Return the top circle of the cylinder. More...

boolean	IsOuter ()
	To know if the SCylinder is set to be scanned from the inside or from the outside. More...

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

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

	SCylinder (SPoint center, SVector normalDir, number radius, number length)
	Construct a custom SCylinder from a given center point, normal direction, radius and length. More...

	SCylinder (SPoint firstPt, SPoint secondPt, SPoint thirdPt, SPoint fourthPt)
	Construct a new SCylinder by 4 points. More...

	SetInner ()
	Set the SCylinder to a cylinder scanned from the inside. More...

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

	SetOuter ()
	Set the SCylinder to a cylinder scanned from the outside. More...

	SetRadius (number radius)
	Set the radius. 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< SCylinder >	All (VisibilityEnum visCrit=SComp.ANY_VISIBILITY)
	Get all the SCylinder in the document. More...

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

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

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

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

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

static SCylinder	New (SPoint center, SVector normalDir, number radius, number length)
	Construct a custom SCylinder from a given center point, normal direction, radius and length. More...

static SCylinder	New (SPoint firstPt, SPoint secondPt, SPoint thirdPt, SPoint fourthPt)
	Construct a new SCylinder by 4 points. 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 cylinder edition and creation methods.

Constructor & Destructor Documentation

◆ SCylinder() [1/4]

SCylinder::SCylinder ( )

Default constructor to create an empty new SCylinder.

◆ SCylinder() [2/4]

SCylinder::SCylinder ( SCylinder other )

Construct a SCylinder by copying another SCylinder.

Parameters

other (SCylinder) The SCylinder to copy

◆ SCylinder() [3/4]

SCylinder::SCylinder	(	SPoint	center,
		SVector	normalDir,
		number	radius,
		number	length
	)

Construct a custom SCylinder from a given center point, normal direction, radius and length.

Parameters

center	(SPoint) Cylinder center; the cylinder starts from this extremity in its normal direction.
normalDir	(SVector) Cylinder normal direction
radius	(number) Cylinder radius
length	(number) Cylinder length

◆ SCylinder() [4/4]

SCylinder::SCylinder	(	SPoint	firstPt,
		SPoint	secondPt,
		SPoint	thirdPt,
		SPoint	fourthPt
	)

Construct a new SCylinder by 4 points.

Note: The 4 points must be not identical.If you want to construct a cylinder with more than 4 points, use SCloud.BestCylinder().The three first points define a base circle. The fourth point is used to calculate length.

Parameters

firstPt	(SPoint) First point on the cylinder (base circle)
secondPt	(SPoint) Second point on the cylinder (base circle)
thirdPt	(SPoint) Third point on the cylinder (base circle)
fourthPt	(SPoint) Fourth point on the cylinder to calculate length

Member Function Documentation

◆ All()

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

static

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

◆ Discretize()

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

Convert the cylinder into a discretized SPoly. Only one parameter 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.Poly	(SPoly) The discretized SPoly

◆ Distance()

number SCylinder::Distance ( SPoint point )

Return the distance between a point and the cylinder.

Parameters

point (SPoint) The point from which the distance to the feature has to be calculated

Return values

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

◆ FromClick()

static Object SCylinder::FromClick ( )

static

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

◆ FromName()

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

static

Search all the SCylinder with the given name.

Parameters

name	(string) The name to find

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

◆ FromSel()

static Array< SCylinder > SCylinder::FromSel ( )

static

Get all the selected SCylinder.

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

◆ GetBaseCenter()

SPoint SCylinder::GetBaseCenter ( )

Return the base center of the cylinder.

Note: This function is the same as SFeature.GetCenter()

Returns: (SPoint) The base center of the cylinder

◆ GetBaseCircle()

SCircle SCylinder::GetBaseCircle ( )

Return the base circle of the cylinder.

Returns: (SCircle) The base circle of the cylinder

◆ GetLength()

number SCylinder::GetLength ( )

Return the length of the cylinder.

Returns: (number) The length of the cylinder

◆ GetRadius()

number SCylinder::GetRadius ( )

Return the radius of the cylinder.

Returns: (number) The radius of the cylinder

◆ GetSurface()

number SCylinder::GetSurface ( )

Return the surface of the cylinder.

Returns: (number) The surface of the cylinder

◆ GetTopCenter()

SPoint SCylinder::GetTopCenter ( )

Return the top center of the cylinder.

Returns: (SPoint) The top center of the cylinder

◆ GetTopCircle()

SCircle SCylinder::GetTopCircle ( )

Return the top circle of the cylinder.

Returns: (SCircle) The top circle of the cylinder

◆ IsOuter()

boolean SCylinder::IsOuter ( )

To know if the SCylinder is set to be scanned from the inside or from the outside.

Return values

true	The cylinder was defined as being scanned from the outside
false	The cylinder was defined as being scanned from the inside

◆ New() [1/4]

static SCylinder SCylinder::New ( )

static

Default constructor to create an empty new SCylinder.

Returns: (SCylinder) The new SCylinder.

◆ New() [2/4]

static SCylinder SCylinder::New ( SCylinder other )

static

Construct a SCylinder by copying another SCylinder.

Parameters

other (SCylinder) The SCylinder to copy

Returns: (SCylinder) The new SCylinder.

◆ New() [3/4]

static SCylinder SCylinder::New	(	SPoint	center,
		SVector	normalDir,
		number	radius,
		number	length
	)

static

Construct a custom SCylinder from a given center point, normal direction, radius and length.

Parameters

center	(SPoint) Cylinder center; the cylinder starts from this extremity in its normal direction.
normalDir	(SVector) Cylinder normal direction
radius	(number) Cylinder radius
length	(number) Cylinder length

Returns: (SCylinder) The new SCylinder.

◆ New() [4/4]

static SCylinder SCylinder::New	(	SPoint	firstPt,
		SPoint	secondPt,
		SPoint	thirdPt,
		SPoint	fourthPt
	)

static

Construct a new SCylinder by 4 points.

Note: The 4 points must be not identical.If you want to construct a cylinder with more than 4 points, use SCloud.BestCylinder().The three first points define a base circle. The fourth point is used to calculate length.

Parameters

firstPt	(SPoint) First point on the cylinder (base circle)
secondPt	(SPoint) Second point on the cylinder (base circle)
thirdPt	(SPoint) Third point on the cylinder (base circle)
fourthPt	(SPoint) Fourth point on the cylinder to calculate length

Returns: (SCylinder) The new SCylinder.

◆ SetInner()

SCylinder::SetInner ( )

Set the SCylinder to a cylinder scanned from the inside.

◆ SetLength()

SCylinder::SetLength ( number length )

Set the length.

Parameters

length (number) The length to set

◆ SetOuter()

SCylinder::SetOuter ( )

Set the SCylinder to a cylinder scanned from the outside.

◆ SetRadius()

SCylinder::SetRadius ( number radius )

Set the radius.

Parameters

radius (number) The radius to set

◆ toString()

string SCylinder::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

◆ SCylinder() [1/4]

◆ SCylinder() [2/4]

◆ SCylinder() [3/4]

◆ SCylinder() [4/4]

Member Function Documentation

◆ All()

◆ Discretize()

◆ Distance()

◆ FromClick()

◆ FromName()

◆ FromSel()

◆ GetBaseCenter()

◆ GetBaseCircle()

◆ GetLength()

◆ GetRadius()

◆ GetSurface()

◆ GetTopCenter()

◆ GetTopCircle()

◆ IsOuter()

◆ New() [1/4]

◆ New() [2/4]

◆ New() [3/4]

◆ New() [4/4]

◆ SetInner()

◆ SetLength()

◆ SetOuter()

◆ SetRadius()

◆ toString()