S2ClosestPointQueryOptions

Options that control the set of points returned. Note that by default *all* points are returned, so you will always want to set either the max_points() option or the max_distance() option (or both).

This class is also available as S2ClosestPointQuery<Data>::Options. (It is defined here to avoid depending on the "Data" template argument.)

class S2ClosestPointQueryOptions : S2ClosestPointQueryBaseOptions!S2MinDistance {

alias Distance = S2MinDistance;

alias Base = S2ClosestPointQueryBaseOptions!Distance;

void setMaxDistance(S1ChordAngle max_distance);

alias setMaxDistance = Base.setMaxDistance;

void setInclusiveMaxDistance(S1ChordAngle max_distance);

void setConservativeMaxDistance(S1ChordAngle max_distance);

void setMaxDistance(S1Angle max_distance);

void setInclusiveMaxDistance(S1Angle max_distance);

void setConservativeMaxDistance(S1Angle max_distance);

void setMaxError(S1Angle max_error);

}

Members

Aliases

Base alias Base = S2ClosestPointQueryBaseOptions!Distance: Undocumented in source.
Distance alias Distance = S2MinDistance: Undocumented in source.
setMaxDistance alias setMaxDistance = Base.setMaxDistance: Undocumented in source.

Functions

setConservativeMaxDistance void setConservativeMaxDistance(S1Angle max_distance): Undocumented in source. Be warned that the author may not have intended to support it.
setConservativeMaxDistance void setConservativeMaxDistance(S1ChordAngle max_distance): Like set_inclusive_max_distance(), except that "max_distance" is also increased by the maximum error in the distance calculation. This ensures that all points whose true distance is less than or equal to "max_distance" will be returned (along with some points whose true distance is slightly greater).
setInclusiveMaxDistance void setInclusiveMaxDistance(S1ChordAngle max_distance): Like set_max_distance(), except that points whose distance is exactly equal to "max_distance" are also returned. Equivalent to calling set_max_distance(max_distance.Successor()).
setInclusiveMaxDistance void setInclusiveMaxDistance(S1Angle max_distance): Undocumented in source. Be warned that the author may not have intended to support it.
setMaxDistance void setMaxDistance(S1ChordAngle max_distance): Specifies that only points whose distance to the target is less than "max_distance" should be returned.
setMaxDistance void setMaxDistance(S1Angle max_distance): Versions of set_max_distance that take an S1Angle argument. (Note that these functions require a conversion, and that the S1ChordAngle versions are preferred.)
setMaxError void setMaxError(S1Angle max_error): See S2ClosestPointQueryBaseOptions for documentation.

S2ClosestPointQueryOptions

Members

Aliases

Functions

Meta

Source