![]() |
Cyclone 3DR Script
from Technodigit, part of Hexagon. Copyright 1997-2025.
|
Provide feature to manage alignment objects (such as road or tunnel axis) usually defined in LandXML files. More...
Public Member Functions | |
Object | ConvertToPolyline () |
Converts the alignment into polylines. More... | |
Object | GetDistance (SPoint pointToProject) |
Return the 3D distance, vertical, horizontal, the nearest station and the coordinates if the projected point. More... | |
Object | GetLength () |
Return both 3D and 2D lengths of the alignment. More... | |
Object | GetPoint (number abscissa) |
Get the corresponding 2D point and 3D point from a given station (abscissa) More... | |
Object | GetStationStarts () |
Get a list of station starts usually defined in a LandXML file. More... | |
SAlignment () | |
Default constructor. More... | |
string | toString () |
Get the type of the variable. More... | |
string | ValuesToString () |
Get a debug string representation of the SAlignment. More... | |
![]() | |
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< SAlignment > | All (VisibilityEnum visCrit=SComp.ANY_VISIBILITY) |
Get all the SAlignment in the document. More... | |
static Object | FromClick () |
Launch an interaction to select a SAlignment in the scene. More... | |
static Array< SAlignment > | FromName (string name) |
Search all the SAlignment with the given name. More... | |
static Array< SAlignment > | FromSel () |
Get all the selected SAlignment. More... | |
![]() | |
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 | |
![]() | |
enum | VisibilityEnum { HIDDEN_ONLY = 0 , VISIBLE_ONLY = 1 , ANY_VISIBILITY = 2 } |
Visible criteria. More... | |
Provide feature to manage alignment objects (such as road or tunnel axis) usually defined in LandXML files.
SAlignment::SAlignment | ( | ) |
Default constructor.
|
static |
Get all the SAlignment in the document.
visCrit | (VisibilityEnum) Visible selection criteria
|
Object SAlignment::ConvertToPolyline | ( | ) |
Converts the alignment into polylines.
ret.Multis2D | (Array<SMultiline>) Get 2D multilines corresponding to the planar axis |
ret.Multis3D | (Array<SMultiline>) Get 3D multilines corresponding to the planar axis |
|
static |
Launch an interaction to select a SAlignment in the scene.
ret.ErrorCode | (number) The error code
|
ret.Alignment | (SAlignment) The selected SAlignment |
|
static |
Search all the SAlignment with the given name.
name | (string) The name to find |
|
static |
Get all the selected SAlignment.
Object SAlignment::GetDistance | ( | SPoint | pointToProject | ) |
Return the 3D distance, vertical, horizontal, the nearest station and the coordinates if the projected point.
pointToProject | (SPoint) The input point to project on the alignment. |
ret.ErrorCode | (number) The error code
|
ret.Distance3D | (number) 3D distance between the input point and the projected point. |
ret.Horizontal | (number) The horizontal distance between the input point and the projected point. |
ret.Vertical | (number) The vertical distance between the input point and the projected point. |
ret.Station | (number) The value of the nearest station. |
ret.ProjectedPoint | (SPoint) 3D point projected on the alignment. |
Object SAlignment::GetLength | ( | ) |
Return both 3D and 2D lengths of the alignment.
ret.Length2D | (number) 2D length of the alignment |
ret.Length3D | (number) 3D length of the alignment |
Object SAlignment::GetPoint | ( | number | abscissa | ) |
Get the corresponding 2D point and 3D point from a given station (abscissa)
abscissa | (number) Station abscissa along the alignment |
Object SAlignment::GetStationStarts | ( | ) |
Get a list of station starts usually defined in a LandXML file.
ret.StaStartTbl | (Array<Object>) Get a list of station starts usually defined in a LandXML file. Each member of the table is a structure with the following members:
|
string SAlignment::toString | ( | ) |
Get the type of the variable.
string SAlignment::ValuesToString | ( | ) |
Get a debug string representation of the SAlignment.