Click or drag to resize

PointInRegionNearestToReferencePoint Class

A Point that is within an EllipsoidSurfaceRegion that is closest to a reference point which may be found in, on, or outside of the region.
Inheritance Hierarchy

Namespace:  AGI.Foundation.Geometry
Assembly:  AGI.Foundation.Models (in AGI.Foundation.Models.dll) Version: 24.3.420.0 (24.3.420.0)
Syntax
public class PointInRegionNearestToReferencePoint : Point

The PointInRegionNearestToReferencePoint type exposes the following members.

Constructors
Properties
  NameDescription
Public propertyCentralBody
Gets or sets the CentralBody on which the SurfaceRegion is located.
Public propertyIsFrozen
Gets a value indicating whether this object is frozen. A frozen object cannot be modified and an ObjectFrozenException will be thrown if an attempt is made to do so.
(Inherited from DefinitionalObject.)
Public propertyReferencePoint
Gets or sets the point which is on, or will be projected on, the surface of the ellipsoid in which the region is defined.
Public propertySurfaceRegion
Gets or sets the EllipsoidSurfaceRegion which defines the area in which the point will be located.
Top
Methods
  NameDescription
Protected methodCheckForSameDefinition(DefinitionalObject)
Checks to determine if another instance has the same definition as this instance and returns if it does. Derived classes MUST override this method and check all new fields introduced by the derived class for definitional equivalence. It is NOT necessary to check base class fields because the base class will already have done that. When overriding this method, you should NOT call the base implementation because it will return for all derived-class instances. Derived classes should check the type of other to preserve the symmetric nature of IsSameDefinition(Object).
(Inherited from Point.)
Protected methodCheckForSameDefinition(Point)
Checks to determine if another instance has the same definition as this instance and returns if it does. Derived classes MUST override this method and check all new fields introduced by the derived class for definitional equivalence. It is NOT necessary to check base class fields because the base class will already have done that. When overriding this method, you should NOT call the base implementation because it will return for all derived-class instances. Derived classes should check the type of other to preserve the symmetric nature of IsSameDefinition(Object).
(Overrides PointCheckForSameDefinition(Point).)
Protected methodCheckForSameDefinition(PointInRegionNearestToReferencePoint)
Checks to determine if another instance has the same definition as this instance and returns if it does. Derived classes MUST override this method and check all new fields introduced by the derived class for definitional equivalence. It is NOT necessary to check base class fields because the base class will already have done that. When overriding this method, you should NOT call the base implementation because it will return for all derived-class instances. Derived classes should check the type of other to preserve the symmetric nature of IsSameDefinition(Object).
Public methodClone
Clones this object using the specified context.
(Overrides DefinitionalObjectClone(CopyContext).)
Protected methodComputeCurrentDefinitionHashCode
Computes a hash code based on the current properties of this object. Derived classes MUST override this method and compute a hash code that combines: a unique hash code seed, the base implementation result, and the hash codes of all new fields introduced by the derived class which are used in the CheckForSameDefinition(DefinitionalObject) method.
(Overrides PointComputeCurrentDefinitionHashCode.)
Public methodCreateVectorAcceleration
Constructs a vector which represents the second derivative of this point's position.
(Inherited from Point.)
Public methodCreateVectorDerivative
Constructs a vector which represents the requested order of the derivative of this point's position.
(Inherited from Point.)
Public methodCreateVectorVelocity
Constructs a vector which represents the derivative of this point's position.
(Inherited from Point.)
Public methodEnumerateDependencies
Enumerates the dependencies of this object by calling EnumerateT(T) for each object that this object directly depends upon. Derived classes which contain additional dependencies MUST override this method, call the base implementation, and enumerate dependencies introduced by the derived class.
(Overrides DefinitionalObjectEnumerateDependencies(DependencyEnumerator).)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodFreeze
Freezes this object. Further attempts to modify it will result in an ObjectFrozenException.
(Inherited from DefinitionalObject.)
Protected methodFreezeAggregatedObjects
Called by Freeze to also freeze any objects that are considered to be a part of this object. Derived classes which contain additional aggregated objects MUST override this method, call the base implementation, and freeze aggregated objects introduced by the derived class. The objects that need to be frozen in this method are frequently created in this object's constructor and are not settable via properties.
(Inherited from DefinitionalObject.)
Public methodGetDefinitionHashCode
Gets a hash code representing the definition of this object.
(Inherited from DefinitionalObject.)
Public methodGetEvaluator
Gets an evaluator that can be used to find the motion of this point in its parent reference frame at a given date. Consider using the methods of GeometryTransformer instead of calling this method directly. See GetEvaluator(EvaluatorGroup) for more details.
(Inherited from Point.)
Public methodGetEvaluator(EvaluatorGroup)
Gets an evaluator that can be used to find the Motion<Cartesian> of this point at a given JulianDate. Adds the evaluator to the EvaluatorGroup.
(Overrides PointGetEvaluator(EvaluatorGroup).)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetScalarElement(CartesianElement, ReferenceFrame)
Returns a Scalar representing the X, Y, Z, or Magnitude of this point.
(Inherited from Point.)
Public methodGetScalarElement(CartesianElement, ReferenceFrame, Int32)
Returns a Scalar representing the X, Y, Z, or Magnitude, or any derivative of those elements of this point.
(Inherited from Point.)
Public methodGetService
Gets the service object of the specified type.
(Inherited from Point.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodIsSameDefinition
Determines if this object has the same definition as another object.
(Inherited from DefinitionalObject.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodThrowIfFrozen
Throws ObjectFrozenException if this object IsFrozen. This method should be called from any method or property that modifies this object.
(Inherited from DefinitionalObject.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Remarks
If the ReferencePoint has non-zero altitude relative to the central body's ellipsoid, then the reference point is projected on the surface of the ellipsoid, and the point in the region is relative to this projected point.
See Also