ScalarOccultation Class 
A class that provides evaluators for percentage of occultation/eclipse at a position, as well as EclipseType.
The percentage runs from 0.0 (completely lit) to 1.0 (total eclipse).
Namespace: AGI.Foundation.Celestial
The ScalarOccultation type exposes the following members.
Name  Description  

ScalarOccultation 
Creates a new Scalar with a VectorType of CorrectForLightTimeDelayAndAberration.
IlluminatingBody and TargetPoint must be set before an Evaluator is created,
and generally at least one body should be added to OccludingBodies.
 
ScalarOccultation(ScalarOccultation, CopyContext)  Initializes a new instance as a copy of an existing instance.  
ScalarOccultation(CentralBody, Point, CentralBody) 
Creates a new Scalar from the given illuminating body, target point,
and occluding bodies.

Name  Description  

IlluminatingBody 
Gets or sets the body to use for the illuminating body (commonly the sun).
 
InertialFrame 
Gets or sets an alternate inertial reference frame. This property is by default, and
if it remains then the Inertial Frame
of the IlluminatingBody will be used.
The inertial frame is used to correct the position vectors for light time delay and aberration if the appropriate RadiationVectorType is set.  
IsFrozen 
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.)  
OccludingBodies 
Gets a list of bodies which obscure the illuminating body.
 
TargetPoint 
Gets or sets the Point representing the location at which
the occultation factor is being calculated.
 
VectorType 
Gets or sets whether or not to use true position to calculate the occultation, or apparent position adjusted for aberration.
By default set to CorrectForLightTimeDelayAndAberration.

Name  Description  

Add(Double) 
Adds a fixed scalar to this one.
(Inherited from Scalar.)  
Add(Scalar) 
Adds another scalar to this one.
(Inherited from Scalar.)  
CheckForSameDefinition(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 derivedclass instances.
Derived classes should check the type of other to preserve the symmetric nature of IsSameDefinition(Object).
(Inherited from Scalar.)  
CheckForSameDefinition(Scalar) 
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 derivedclass instances.
Derived classes should check the type of other to preserve the symmetric nature of IsSameDefinition(Object).
(Overrides ScalarCheckForSameDefinition(Scalar).)  
CheckForSameDefinition(ScalarOccultation) 
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 derivedclass instances.
Derived classes should check the type of other to preserve the symmetric nature of IsSameDefinition(Object).
 
Clone 
Clones this object using the specified context.
(Inherited from DefinitionalObject.)  
ComputeCurrentDefinitionHashCode 
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 ScalarComputeCurrentDefinitionHashCode.)  
CreateEvaluatorHelper 
Checks all properties and creates the vectors required to evaluate occultation fractions.
 
CreateScalarDerivative 
Constructs a scalar which represents a derivative of this scalar.
(Inherited from Scalar.)  
Divide(Double) 
Divides this scalar (numerator) by a fixed value (denominator).
(Inherited from Scalar.)  
Divide(Scalar) 
Divides this scalar (numerator) by another one (denominator).
(Inherited from Scalar.)  
EclipseAngles 
Returns the angles needed for the various eclipse calculations in the format
[relative angle, eclipse body half angle, illuminating body half angle].
 
EnumerateDependencies 
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).)  
Equals  (Inherited from Object.)  
Finalize  Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)  
Freeze 
Freezes this object. Further attempts to modify it will result
in an ObjectFrozenException.
(Inherited from DefinitionalObject.)  
FreezeAggregatedObjects 
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.)  
GetDefinitionHashCode 
Gets a hash code representing the definition of this object.
(Inherited from DefinitionalObject.)  
GetEclipseTypeEvaluators  
GetEclipseTypeEvaluators(EvaluatorGroup)  
GetEvaluator 
Gets an evaluator that can be used to find the value of this scalar function at a given JulianDate.
(Inherited from Scalar.)  
GetEvaluator(EvaluatorGroup) 
Gets an evaluator that can be used to find the value of this scalar function at a given JulianDate.
Adds the evaluator to the EvaluatorGroup.
(Inherited from Scalar.)  
GetHashCode  Serves as a hash function for a particular type. (Inherited from Object.)  
GetType  Gets the Type of the current instance. (Inherited from Object.)  
IsSameDefinition 
Determines if this object has the same definition as another object.
(Inherited from DefinitionalObject.)  
MemberwiseClone  Creates a shallow copy of the current Object. (Inherited from Object.)  
Multiply(Double) 
Multiplies this scalar with a fixed value.
(Inherited from Scalar.)  
Multiply(Scalar) 
Multiplies another scalar with this one.
(Inherited from Scalar.)  
Power 
Raises this scalar to the given fixed exponent.
(Inherited from Scalar.)  
Subtract(Double) 
Subtracts a fixed scalar from this one.
(Inherited from Scalar.)  
Subtract(Scalar) 
Subtracts another scalar from this one.
(Inherited from Scalar.)  
ThrowIfFrozen 
Throws ObjectFrozenException if this object IsFrozen.
This method should be called from any method or property that modifies this object.
(Inherited from DefinitionalObject.)  
ToString  Returns a string that represents the current object. (Inherited from Object.) 