cPointObjGetCoordCartesian Method

Retrieves the x, y and z coordinates of the specified point object in the Present Units.

Namespace:  ETABS2016
Assembly:  ETABS2016 (in ETABS2016.dll) Version: 16.0.0.0 (16.0.0.0)
Syntax
Copy
int GetCoordCartesian(
	string Name,
	ref double X,
	ref double Y,
	ref double Z,
	string CSys = "Global"
)

Parameters

Name
Type: SystemString
The name of a defined point object.
X
Type: SystemDouble
Y
Type: SystemDouble
Z
Type: SystemDouble
CSys (Optional)
Type: SystemString
The name of a defined coordinate system. If Csys is not specified, the Global coordinate system is assumed.

Return Value

Type: Int32
Returns zero if the coordinates are successfully returned; otherwise it returns nonzero.
Remarks
The coordinates are reported in the coordinate system specified by CSys.
Examples
VB
Copy
Public Sub Example()
       Dim SapModel As cSapModel
       Dim EtabsObject As cOAPI
       Dim ret As Integer = -1
       Dim x As Double, y As Double, z As Double

   'create ETABS object
       EtabsObject = CreateObject("CSI.ETABS.API.ETABSObject")

   'start ETABS application
       ret = EtabsObject.ApplicationStart()

   'create SapModel object
       SapModel = EtabsObject.SapModel

   'initialize model
       ret = SapModel.InitializeNewModel()

   'create steel deck template model
       ret = SapModel.File.NewSteelDeck(4, 12, 12, 4, 4, 24, 24)

   'get point coordinates
       ret = SapModel.PointObj.GetCoordCartesian("1", x, y, z)

   'close ETABS
       EtabsObject.ApplicationExit(False)

   'clean up variables
       SapModel = Nothing
       EtabsObject = Nothing
   End Sub
See Also