-
Notifications
You must be signed in to change notification settings - Fork 262
/
Polygon.xml
297 lines (297 loc) · 16.8 KB
/
Polygon.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
<Type Name="Polygon" FullName="Microsoft.Azure.Cosmos.Spatial.Polygon">
<TypeSignature Language="C#" Value="public sealed class Polygon : Microsoft.Azure.Cosmos.Spatial.Geometry, IEquatable<Microsoft.Azure.Cosmos.Spatial.Polygon>" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit Polygon extends Microsoft.Azure.Cosmos.Spatial.Geometry implements class System.IEquatable`1<class Microsoft.Azure.Cosmos.Spatial.Polygon>" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Cosmos.Spatial.Polygon" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class Polygon
Inherits Geometry
Implements IEquatable(Of Polygon)" />
<TypeSignature Language="F#" Value="type Polygon = class
 inherit Geometry
 interface IEquatable<Polygon>" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
<AssemblyVersion>3.17.1.0</AssemblyVersion>
<AssemblyVersion>3.18.0.0</AssemblyVersion>
<AssemblyVersion>3.19.0.0</AssemblyVersion>
<AssemblyVersion>3.20.0.0</AssemblyVersion>
<AssemblyVersion>3.20.1.0</AssemblyVersion>
<AssemblyVersion>3.21.0.0</AssemblyVersion>
<AssemblyVersion>3.22.0.0</AssemblyVersion>
<AssemblyVersion>3.22.1.0</AssemblyVersion>
<AssemblyVersion>3.23.0.0</AssemblyVersion>
<AssemblyVersion>3.24.0.0</AssemblyVersion>
<AssemblyVersion>3.25.0.0</AssemblyVersion>
<AssemblyVersion>3.26.0.0</AssemblyVersion>
<AssemblyVersion>3.26.1.0</AssemblyVersion>
<AssemblyVersion>3.26.2.0</AssemblyVersion>
<AssemblyVersion>3.27.0.0</AssemblyVersion>
<AssemblyVersion>3.27.1.0</AssemblyVersion>
<AssemblyVersion>3.27.2.0</AssemblyVersion>
<AssemblyVersion>3.28.0.0</AssemblyVersion>
<AssemblyVersion>3.29.0.0</AssemblyVersion>
<AssemblyVersion>3.30.0.0</AssemblyVersion>
<AssemblyVersion>3.30.1.0</AssemblyVersion>
<AssemblyVersion>3.31.0.0</AssemblyVersion>
<AssemblyVersion>3.31.1.0</AssemblyVersion>
<AssemblyVersion>3.31.2.0</AssemblyVersion>
<AssemblyVersion>3.35.4.0</AssemblyVersion>
<AssemblyVersion>3.36.0.0</AssemblyVersion>
<AssemblyVersion>3.38.1.0</AssemblyVersion>
<AssemblyVersion>3.39.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>Microsoft.Azure.Cosmos.Spatial.Geometry</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>System.IEquatable<Microsoft.Azure.Cosmos.Spatial.Polygon></InterfaceName>
</Interface>
</Interfaces>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Runtime.Serialization.DataContract]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.Serialization.DataContract>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>
<para>
Polygon geometry class in the Azure Cosmos DB service.
</para>
<para>
A polygon is represented by the set of "polygon rings". Each ring is closed line string.
First ring defines external ring. All subsequent rings define "holes" in the external ring.
</para>
<para>
Rings must be specified using Left Hand Rule: traversing the ring in the order of its points, should result
in internal area of the polygon being to the left side.
</para>
</summary>
<remarks>To be added.</remarks>
<example>
This example shows how to define a polygon which covers small portion of the Earth:
<code language="c#"><![CDATA[
var polygon = new Polygon(
new[]
{
new Position(20.0, 20.0),
new Position(30.0, 20.0),
new Position(30.0, 30.0),
new Position(20.0, 30.0)
new Position(20.0, 20.0)
});
]]></code></example>
<example>
This example shows how to define a polygon which covers area more than one hemisphere:
(Notice that only order of coordinates was reversed).
<code language="c#"><![CDATA[
var polygon = new Polygon(
new[]
{
new Position(20.0, 20.0),
new Position(20.0, 30.0),
new Position(30.0, 30.0),
new Position(30.0, 20.0)
new Position(20.0, 20.0)
});
]]></code></example>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Polygon (System.Collections.Generic.IList<Microsoft.Azure.Cosmos.Spatial.LinearRing> rings);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Collections.Generic.IList`1<class Microsoft.Azure.Cosmos.Spatial.LinearRing> rings) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Cosmos.Spatial.Polygon.#ctor(System.Collections.Generic.IList{Microsoft.Azure.Cosmos.Spatial.LinearRing})" />
<MemberSignature Language="VB.NET" Value="Public Sub New (rings As IList(Of LinearRing))" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.Cosmos.Spatial.Polygon : System.Collections.Generic.IList<Microsoft.Azure.Cosmos.Spatial.LinearRing> -> Microsoft.Azure.Cosmos.Spatial.Polygon" Usage="new Microsoft.Azure.Cosmos.Spatial.Polygon rings" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
<AssemblyVersion>3.39.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="rings" Type="System.Collections.Generic.IList<Microsoft.Azure.Cosmos.Spatial.LinearRing>" />
</Parameters>
<Docs>
<param name="rings">
<para>
Polygon rings.
</para>
<para>
First ring is external ring. Following rings define 'holes' in the polygon.
</para>
</param>
<summary>
Initializes a new instance of the <see cref="T:Microsoft.Azure.Cosmos.Spatial.Polygon" /> class in the Azure Cosmos DB service.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Polygon (System.Collections.Generic.IList<Microsoft.Azure.Cosmos.Spatial.Position> externalRingPositions);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Collections.Generic.IList`1<class Microsoft.Azure.Cosmos.Spatial.Position> externalRingPositions) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Cosmos.Spatial.Polygon.#ctor(System.Collections.Generic.IList{Microsoft.Azure.Cosmos.Spatial.Position})" />
<MemberSignature Language="VB.NET" Value="Public Sub New (externalRingPositions As IList(Of Position))" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.Cosmos.Spatial.Polygon : System.Collections.Generic.IList<Microsoft.Azure.Cosmos.Spatial.Position> -> Microsoft.Azure.Cosmos.Spatial.Polygon" Usage="new Microsoft.Azure.Cosmos.Spatial.Polygon externalRingPositions" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
<AssemblyVersion>3.39.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="externalRingPositions" Type="System.Collections.Generic.IList<Microsoft.Azure.Cosmos.Spatial.Position>" />
</Parameters>
<Docs>
<param name="externalRingPositions">
External polygon ring coordinates.
</param>
<summary>
Initializes a new instance of the <see cref="T:Microsoft.Azure.Cosmos.Spatial.Polygon" /> class,
from external ring (the polygon contains no holes) in the Azure Cosmos DB service.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Polygon (System.Collections.Generic.IList<Microsoft.Azure.Cosmos.Spatial.LinearRing> rings, Microsoft.Azure.Cosmos.Spatial.GeometryParams geometryParams);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Collections.Generic.IList`1<class Microsoft.Azure.Cosmos.Spatial.LinearRing> rings, class Microsoft.Azure.Cosmos.Spatial.GeometryParams geometryParams) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Cosmos.Spatial.Polygon.#ctor(System.Collections.Generic.IList{Microsoft.Azure.Cosmos.Spatial.LinearRing},Microsoft.Azure.Cosmos.Spatial.GeometryParams)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (rings As IList(Of LinearRing), geometryParams As GeometryParams)" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.Cosmos.Spatial.Polygon : System.Collections.Generic.IList<Microsoft.Azure.Cosmos.Spatial.LinearRing> * Microsoft.Azure.Cosmos.Spatial.GeometryParams -> Microsoft.Azure.Cosmos.Spatial.Polygon" Usage="new Microsoft.Azure.Cosmos.Spatial.Polygon (rings, geometryParams)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
<AssemblyVersion>3.39.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="rings" Type="System.Collections.Generic.IList<Microsoft.Azure.Cosmos.Spatial.LinearRing>" />
<Parameter Name="geometryParams" Type="Microsoft.Azure.Cosmos.Spatial.GeometryParams" />
</Parameters>
<Docs>
<param name="rings">
Polygon rings.
</param>
<param name="geometryParams">
Additional geometry parameters.
</param>
<summary>
Initializes a new instance of the <see cref="T:Microsoft.Azure.Cosmos.Spatial.Polygon" /> class in the Azure Cosmos DB service.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Equals">
<MemberSignature Language="C#" Value="public bool Equals (Microsoft.Azure.Cosmos.Spatial.Polygon other);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool Equals(class Microsoft.Azure.Cosmos.Spatial.Polygon other) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Cosmos.Spatial.Polygon.Equals(Microsoft.Azure.Cosmos.Spatial.Polygon)" />
<MemberSignature Language="VB.NET" Value="Public Function Equals (other As Polygon) As Boolean" />
<MemberSignature Language="F#" Value="override this.Equals : Microsoft.Azure.Cosmos.Spatial.Polygon -> bool" Usage="polygon.Equals other" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:System.IEquatable`1.Equals(`0)</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
<AssemblyVersion>3.39.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="other" Type="Microsoft.Azure.Cosmos.Spatial.Polygon" />
</Parameters>
<Docs>
<param name="other">
<see cref="T:Microsoft.Azure.Cosmos.Spatial.Polygon" /> to compare to this <see cref="T:Microsoft.Azure.Cosmos.Spatial.Polygon" />.</param>
<summary>
Determines if this <see cref="T:Microsoft.Azure.Cosmos.Spatial.Polygon" /> is equal to the <paramref name="other" /> in the Azure Cosmos DB service.
</summary>
<returns>
<c>true</c> if objects are equal. <c>false</c> otherwise.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Equals">
<MemberSignature Language="C#" Value="public override bool Equals (object obj);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance bool Equals(object obj) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Cosmos.Spatial.Polygon.Equals(System.Object)" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function Equals (obj As Object) As Boolean" />
<MemberSignature Language="F#" Value="override this.Equals : obj -> bool" Usage="polygon.Equals obj" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
<AssemblyVersion>3.39.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="obj" Type="System.Object" />
</Parameters>
<Docs>
<param name="obj">The object to compare with the current object. </param>
<summary>
Determines whether the specified <see cref="T:Microsoft.Azure.Cosmos.Spatial.Polygon" /> is equal to the current <see cref="T:Microsoft.Azure.Cosmos.Spatial.Polygon" /> in the Azure Cosmos DB service.
</summary>
<returns>
true if the specified object is equal to the current object; otherwise, false.
</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetHashCode">
<MemberSignature Language="C#" Value="public override int GetHashCode ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance int32 GetHashCode() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Cosmos.Spatial.Polygon.GetHashCode" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function GetHashCode () As Integer" />
<MemberSignature Language="F#" Value="override this.GetHashCode : unit -> int" Usage="polygon.GetHashCode " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
<AssemblyVersion>3.39.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Serves as a hash function for the <see cref="T:Microsoft.Azure.Cosmos.Spatial.Polygon" /> type in the Azure Cosmos DB service.
</summary>
<returns>
A hash code for the current <see cref="T:Microsoft.Azure.Cosmos.Spatial.Polygon" />.
</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Rings">
<MemberSignature Language="C#" Value="public System.Collections.ObjectModel.ReadOnlyCollection<Microsoft.Azure.Cosmos.Spatial.LinearRing> Rings { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.ObjectModel.ReadOnlyCollection`1<class Microsoft.Azure.Cosmos.Spatial.LinearRing> Rings" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Cosmos.Spatial.Polygon.Rings" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Rings As ReadOnlyCollection(Of LinearRing)" />
<MemberSignature Language="F#" Value="member this.Rings : System.Collections.ObjectModel.ReadOnlyCollection<Microsoft.Azure.Cosmos.Spatial.LinearRing>" Usage="Microsoft.Azure.Cosmos.Spatial.Polygon.Rings" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
<AssemblyVersion>3.39.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty("coordinates", Order=1, Required=Newtonsoft.Json.Required.Always)]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty("coordinates", Order=1, Required=Newtonsoft.Json.Required.Always)>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.Runtime.Serialization.DataMember(Name="coordinates")]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.Serialization.DataMember(Name="coordinates")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Collections.ObjectModel.ReadOnlyCollection<Microsoft.Azure.Cosmos.Spatial.LinearRing></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the polygon rings in the Azure Cosmos DB service.
</summary>
<value>
Polygon rings.
</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>