Struct gapi_grpc::google::maps::playablelocations::v3::sample::SpacingOptions

pub struct SpacingOptions {
    pub min_spacing_meters: f64,
    pub point_type: i32,
}

A set of options that specifies the separation between playable locations.

Fields

min_spacing_meters: f64

Required. The minimum spacing between any two playable locations, measured in meters. The minimum value is 30. The maximum value is 1000.

Inputs will be rounded up to the next 10 meter interval.

The default value is 200m.

Set this field to remove tight clusters of playable locations.

Note:

The spacing is a greedy algorithm. It optimizes for selecting the highest ranking locations first, not to maximize the number of locations selected. Consider the following scenario:

• Rank: A: 2, B: 1, C: 3.
• Distance: A–200m–B–200m–C

If spacing=250, it will pick the highest ranked location [B], not [A, C].

Note:

Spacing works within the game object type itself, as well as the previous ones. Suppose three game object types, each with the following spacing:

• X: 400m, Y: undefined, Z: 200m.

1. Add locations for X, within 400m of each other.
2. Add locations for Y, without any spacing.
3. Finally, add locations for Z within 200m of each other as well X and Y.

The distance diagram between those locations end up as:

• From->To.
• X->X: 400m
• Y->X, Y->Y: unspecified.
• Z->X, Z->Y, Z->Z: 200m.

point_type: i32

Specifies whether the minimum spacing constraint applies to the center-point or to the snapped point of playable locations. The default value is CENTER_POINT.

If a snapped point is not available for a playable location, its center-point is used instead.

Set this to the point type used in your game.

Implementations

impl SpacingOptions

pub fn point_type(&self) -> PointType

Returns the enum value of point_type, or the default if the field is set to an invalid enum value.

pub fn set_point_type(&mut self, value: PointType)

Sets point_type to the provided enum value.

Trait Implementations

impl Clone for SpacingOptions

fn clone(&self) -> SpacingOptions

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SpacingOptions

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for SpacingOptions

fn default() -> SpacingOptions

Returns the “default value” for a type.

impl Message for SpacingOptions

fn encode_raw<B>(&self, buf: &mut B) where
    B: BufMut, 

fn merge_field<B>(
    &mut self,
    tag: u32,
    wire_type: WireType,
    buf: &mut B,
    ctx: DecodeContext
) -> Result<(), DecodeError> where
    B: Buf, 

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

pub fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message to a buffer.

pub fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message with a length-delimiter to a buffer.

pub fn decode<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, 

Decodes an instance of the message from a buffer.

pub fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, 

Decodes a length-delimited instance of the message from the buffer.

pub fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, 

Decodes an instance of the message from a buffer, and merges it into self.

pub fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, 

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq<SpacingOptions> for SpacingOptions

fn eq(&self, other: &SpacingOptions) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &SpacingOptions) -> bool

This method tests for !=.

impl StructuralPartialEq for SpacingOptions