Repository navigation
NavigationPathQueryResult
Home | API by Category | Complete API Index | API Status
| Field | Value |
|---|---|
| Full name | Electron2D.NavigationPathQueryResult |
| Namespace | Electron2D |
| Kind | class |
| Category | API Navigation |
Stores one atomically published typed path and its optional parallel point metadata.
public sealed class Electron2D.NavigationPathQueryResultCaller-owned reusable result. Public arrays are copied both ways; setters remain independent source fields. A successful query publishes all selected arrays/length together, before its optional callback. Reset clears arrays and length. Agent-borrowed instances reject consumer disposal while the owning agent is alive.
Inherits: ElectronObject
| Member | Kind | Summary |
|---|---|---|
public NavigationPathQueryResult() |
constructor | Creates an empty result with zero path length. |
protected override System.Void Dispose(System.Boolean disposing) |
method | |
protected override System.Collections.Generic.IEnumerable<Electron2D.PropertyDescriptor> GetPropertyDescriptors() |
method | |
public System.Void Reset() |
method | Resets all arrays and length to their initial values. |
protected override System.Void ValidateDisposal() |
method | |
public Electron2D.Vector2[] Path { get; set; } |
property | Gets or replaces a copied array of finite world-space path positions. |
public System.Single PathLength { get; set; } |
property | Gets or replaces the independently stored world-space path length. |
public System.UInt64[] PathOwnerIDs { get; set; } |
property | Gets or replaces a copied array of logical instance identities associated with path point owners. |
public Electron2D.RID[] PathRIDs { get; set; } |
property | Gets or replaces a copied array of region/link RID owners of path points. |
public Electron2D.NavigationPathQueryResult.PathSegmentType[] PathTypes { get; set; } |
property | Gets or replaces a copied array of typed region/link owners of path points. |
Kind: constructor
public NavigationPathQueryResult()Creates an empty result with zero path length.
Kind: method
protected override System.Void Dispose(System.Boolean disposing)Kind: method
protected override System.Collections.Generic.IEnumerable<Electron2D.PropertyDescriptor> GetPropertyDescriptors()Kind: method
public System.Void Reset()Resets all arrays and length to their initial values.
-
T:System.ObjectDisposedException: This result is disposed.
Kind: method
protected override System.Void ValidateDisposal()Kind: property
public Electron2D.Vector2[] Path { get; set; }Gets or replaces a copied array of finite world-space path positions.
Empty initially; metadata arrays are empty when their query flags are disabled. Setters are independent.
-
T:System.ArgumentNullException: Assigned array is null. -
T:System.ObjectDisposedException: This result is disposed. -
T:System.ArgumentOutOfRangeException: Positions are nonfinite or point types are unsupported.
Kind: property
public System.Single PathLength { get; set; }Gets or replaces the independently stored world-space path length.
Zero initially and after reset; queries compute it after simplification and clipping.
-
T:System.ArgumentOutOfRangeException: Value is nonfinite or negative. -
T:System.ObjectDisposedException: This result is disposed.
Kind: property
public System.UInt64[] PathOwnerIDs { get; set; }Gets or replaces a copied array of logical instance identities associated with path point owners.
Empty initially; metadata arrays are empty when their query flags are disabled. Setters are independent.
-
T:System.ArgumentNullException: Assigned array is null. -
T:System.ObjectDisposedException: This result is disposed.
Kind: property
public Electron2D.RID[] PathRIDs { get; set; }Gets or replaces a copied array of region/link RID owners of path points.
Empty initially; metadata arrays are empty when their query flags are disabled. Setters are independent.
-
T:System.ArgumentNullException: Assigned array is null. -
T:System.ObjectDisposedException: This result is disposed.
Kind: property
public Electron2D.NavigationPathQueryResult.PathSegmentType[] PathTypes { get; set; }Gets or replaces a copied array of typed region/link owners of path points.
Empty initially; metadata arrays are empty when their query flags are disabled. Setters are independent.
-
T:System.ArgumentNullException: Assigned array is null. -
T:System.ObjectDisposedException: This result is disposed. -
T:System.ArgumentOutOfRangeException: Positions are nonfinite or point types are unsupported.