CogoPointCollection.SetScaleZ(ObjectId, Double) Method

Sets ScaleZ for a single CogoPoint.

Namespace: Autodesk.Civil.DatabaseServices
Assembly: AeccDbMgd (in AeccDbMgd.dll) Version: 13.8.0.280

Syntax

C#

public ObjectId SetScaleZ(
	ObjectId pointId,
	double scale
)

VB

Public Function SetScaleZ ( 
	pointId As ObjectId,
	scale As Double
) As ObjectId

C++

public:
ObjectId SetScaleZ(
	ObjectId pointId, 
	double scale
)

Parameters

pointId  ObjectId

The ObjectId of the point you want to set the ScaleZ property for.

scale  Double

The new ScaleZ value.

Return Value

ObjectId
If the method succeeds, it returns the same ObjectId pointId passed in. If the method fails, it returns ObjectId.Null.

Example

C#

 1// _civildoc is the active CivilDocument instance.
 2// 
 3CogoPointCollection cogoPoints = _civildoc.CogoPoints;
 4ObjectId pointId = cogoPoints.Add(new Point3d(100, 100, 50), false);
 5double zScaleFactor = 1.5;
 6
 7// set value for single point
 8if (cogoPoints.SetScaleZ(pointId, zScaleFactor) == ObjectId.Null)
 9    write("SetScaleZ failed.\n");
10
11Point3dCollection points = new Point3dCollection();
12points.Add(new Point3d(50, 50, 25));
13points.Add(new Point3d(200, 200, 15));
14ObjectIdCollection pointIds = cogoPoints.Add(points, false);
15List<ObjectId> pointIdList = GetListFromCollection(pointIds);
16
17// set multiple points to a single value
18ObjectIdCollection success = cogoPoints.SetScaleZ(pointIdList, zScaleFactor);
19write(String.Format("SetScaleZ success for {0} of {1} points\n",
20   success.Count, pointIdList.Count));
21
22List<double> scales = new List<double>();
23for (int i = 0; i < pointIdList.Count; i++)
24    scales.Add(1 + i * 0.1);
25
26// set multiple points to multiple values
27success = cogoPoints.SetScaleZ(pointIdList, scales);
28write(String.Format("SetScaleZ success for {0} of {1} points\n",
29   success.Count, pointIdList.Count));

VB

 1' _civildoc is the active CivilDocument instance.
 2'
 3Dim cogoPoints As CogoPointCollection = _civildoc.CogoPoints
 4Dim pointId As ObjectId = cogoPoints.Add(New Point3d(100, 100, 50), False)
 5Dim zScaleFactor As Double = 1.5
 6
 7' set value for single point
 8If cogoPoints.SetScaleZ(pointId, zScaleFactor) = ObjectId.Null Then
 9    write("SetScaleZ failed." & vbLf)
10End If
11
12Dim points As New Point3dCollection()
13points.Add(New Point3d(50, 50, 25))
14points.Add(New Point3d(200, 200, 15))
15Dim pointIds As ObjectIdCollection = cogoPoints.Add(points, False)
16Dim pointIdList As List(Of ObjectId) = GetListFromCollection(pointIds)
17
18' set multiple points to a single value
19Dim success As ObjectIdCollection = cogoPoints.SetScaleZ(pointIdList, zScaleFactor)
20write([String].Format("SetScaleZ success for {0} of {1} points", success.Count, pointIdList.Count))
21
22Dim scales As New List(Of Double)()
23For i As Integer = 0 To pointIdList.Count - 1
24    scales.Add(1 + i * 0.1)
25Next
26
27' set multiple points to multiple values
28success = cogoPoints.SetScaleZ(pointIdList, scales)
29write([String].Format("SetScaleZ success for {0} of {1} points", success.Count, pointIdList.Count))

See Also

Reference