Click or drag to resize

AngleInPlaneConstraint Class

An access constraint that projects the displacement vector from one object to another into a given axis-aligned plane and requires that the angle of the projected vector, measured from the first axis defining the plane toward the second, is within a range of values. This constraint is similar to AzimuthAngleConstraint except that is allows for much more flexibility in how the azimuth is defined.
Inheritance Hierarchy

Namespace:  AGI.Foundation.Access.Constraints
Assembly:  AGI.Foundation.Platforms (in AGI.Foundation.Platforms.dll) Version: 24.1.418.0 (24.1.418.0)
Syntax
public class AngleInPlaneConstraint : CircularAccessConstraint, 
	ILinkConstraint

The AngleInPlaneConstraint type exposes the following members.

Constructors
  NameDescription
Public methodAngleInPlaneConstraint
Initializes a new instance.
Protected methodAngleInPlaneConstraint(AngleInPlaneConstraint, CopyContext)
Initializes a new instance as a copy of an existing instance.
Top
Properties
  NameDescription
Public propertyApplicability
Gets or sets the Access situation in which this constraint applies.
(Inherited from AccessConstraint.)
Public propertyConstrainedLink
Gets or sets the link to which this constraint applies. It is not necessary to set this property when using this constraint with AccessComputation.
Public propertyConstrainedLinkEnd
Gets or sets the end of the link to which this constraint applies. This is the end that is observing the angle which is constrained by this constraint. It is not necessary to set this property when using this constraint with AccessComputation.
Public propertyDebuggingLogger
Gets or sets a logger to which debugging information will be written.
(Inherited from AccessQuery.)
Public propertyEvaluationOrder
Gets or sets a number indicating the evaluation order of this constraint relative to other constraints. All constraints involved in an AccessComputation or that share a common parent (e.g. AccessQueryAnd or AccessQueryOr) in an AccessQuery are sorted by this value before being evaluated in ascending order, so constraints with a lower evaluation order are evaluated earlier than constraints with a higher evaluation order.
(Inherited from AccessConstraint.)
Public propertyInvert
Gets or sets a value indicating whether or not the angle should be measured opposite the usual direction. In other words, if this property is , the angle is measured away from the second axis defining the plane (counter-clockwise) rather than toward it.
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 propertyNormalizedStartAngle
Gets the normalized value of StartAngle which lies within TwoPi of zero.
(Inherited from CircularAccessConstraint.)
Public propertyNormalizedStopAngle
Gets the normalized value of StopAngle which lies within TwoPi of zero.
(Inherited from CircularAccessConstraint.)
Public propertyPlane
Gets or sets the plane into which the displacement vector is projected.
Public propertySampling
Gets an instance describing how this constraint is to be sampled.
(Inherited from AccessConstraint.)
Public propertyStartAngle
Gets or sets the angle defining the beginning of the satisfaction region.
(Inherited from CircularAccessConstraint.)
Public propertyStopAngle
Gets or sets the angle defining the end of the satisfaction region
(Inherited from CircularAccessConstraint.)
Public propertyTolerance
Gets or sets the tolerance on the constraint value to use when computing the time when this constraint crosses its threshold.
(Inherited from CircularAccessConstraint.)
Top
Methods
  NameDescription
Public methodBuildQueryEvaluator
Builds a query evaluator from this constraint.
(Overrides AccessConstraintBuildQueryEvaluator(ConstraintQueryBuilder, EvaluatorGroup).)
Protected methodCheckForSameDefinition(AccessConstraint)
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 CircularAccessConstraint.)
Protected methodCheckForSameDefinition(AccessQuery)
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 AccessConstraint.)
Protected methodCheckForSameDefinition(AngleInPlaneConstraint)
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).
Protected methodCheckForSameDefinition(CircularAccessConstraint)
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 CircularAccessConstraintCheckForSameDefinition(CircularAccessConstraint).)
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 AccessQuery.)
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 CircularAccessConstraintComputeCurrentDefinitionHashCode.)
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 AccessConstraintEnumerateDependencies(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 AccessConstraint.)
Public methodStatic memberGetAngleInPlane
Gets the angle formed by a projection of a vector into an axis-aligned plane. The angle is measured from the first axis defining the plane toward the second axis defining the plane.
Public methodGetDefinitionHashCode
Gets a hash code representing the definition of this object.
(Inherited from DefinitionalObject.)
Public methodGetEvaluationOrder
Returns EvaluationOrder, indicating the suggested evaluation order of this constraint when it is used as part of an AccessQuery. Queries that hold sub-queries (such as an AccessQueryAnd) generally evaluate their sub-queries in ascending order of this value, so constraints with a lower evaluation order are evaluated earlier than constraints with a higher evaluation order.
(Inherited from AccessConstraint.)
Public methodGetEvaluator
Gets an evaluator that can be used to evaluate this query for a given time or for intervals of time.
(Inherited from AccessQuery.)
Public methodGetEvaluator(IServiceProvider)
Gets an evaluator that can be used to evaluate this query for a given time or for intervals of time.
(Inherited from AccessQuery.)
Public methodGetEvaluator(IServiceProvider, EvaluatorGroup)
Gets an evaluator that can be used to evaluate this query for a given time or for intervals of time.
(Inherited from AccessConstraint.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
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.)
Public methodSetAngularRegion
Sets the satisfaction region given the two angles forming the boundary: StartAngle and StopAngle. The region is defined from the startAngle increasing to the stopAngle.
(Inherited from CircularAccessConstraint.)
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 methodToDisjunctiveNormalForm
Transforms this query to disjunctive normal form (DNF).
(Inherited from AccessConstraint.)
Public methodToString
Returns a string that represents the current object.
(Overrides ObjectToString.)
Top
Remarks

This constraint requires that both ends of the ConstrainedLink provide ILocationPointService.

After obtaining the normalized displacement vector from the ConstrainedLinkEnd to the other object in the ConstrainedLink, this constraint invokes GetAngleInPlane(UnitCartesian, PlaneIndicator) to compute the angle. If Invert is , the angle is inverted (angle = -angle).

See Also