Namespace Google.Type (2.2.0)

Classes

CalendarPeriodReflection

Holder for reflection information generated from google/type/calendar_period.proto

Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to/from color representations in various languages over compactness; for example, the fields of this representation can be trivially provided to the constructor of "java.awt.Color" in Java; it can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha" method in iOS; and, with just a little work, it can be easily formatted into a CSS "rgba()" string in JavaScript, as well.

Note: this proto does not carry information about the absolute color space that should be used to interpret the RGB value (e.g. sRGB, Adobe RGB, DCI-P3, BT.2020, etc.). By default, applications SHOULD assume the sRGB color space.

Example (Java):

import com.google.type.Color;

// ... public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0;

return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); }

public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); } return resultBuilder.build(); } // ...

Example (iOS / Obj-C):

// ... static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; }

static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return nil; } Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; return result; } // ...

Example (JavaScript):

// ...

var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255);

if (!('alpha' in rgb_color)) { return rgbToCssColor_(red, green, blue); }

var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); };

var rgbToCssColor_ = function(red, green, blue) { var rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); };

// ...

ColorReflection

Holder for reflection information generated from google/type/color.proto

Date

Represents a whole or partial calendar date, e.g. a birthday. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. This can represent:

A full date, with non-zero year, month and day values
A month and day value, with a zero year, e.g. an anniversary
A year on its own, with zero month and day values
A year and month value, with a zero day, e.g. a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

DateExtensions

Extension methods built for Date.

DateReflection

Holder for reflection information generated from google/type/date.proto

DateTime

Represents civil time in one of a few possible ways:

When utc_offset is set and time_zone is unset: a civil time on a calendar day with a particular offset from UTC.
When time_zone is set and utc_offset is unset: a civil time on a calendar day in a particular time zone.
When neither time_zone nor utc_offset is set: a civil time on a calendar day in local time.

The date is relative to the Proleptic Gregorian Calendar.

If year is 0, the DateTime is considered not to have a specific year. month and day must have valid, non-zero values.

This type is more flexible than some applications may want. Make sure to document and validate your application's limitations.

DatetimeReflection

Holder for reflection information generated from google/type/datetime.proto

DayofweekReflection

Holder for reflection information generated from google/type/dayofweek.proto

Expr

Represents an expression text. Example:

title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0"

ExprReflection

Holder for reflection information generated from google/type/expr.proto

Fraction

Represents a fraction in terms of a numerator divided by a denominator.

FractionReflection

Holder for reflection information generated from google/type/fraction.proto

LatLng

An object representing a latitude/longitude pair. This is expressed as a pair of doubles representing degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 standard</a>. Values must be within normalized ranges.

LatlngReflection

Holder for reflection information generated from google/type/latlng.proto

Money

Represents an amount of money with its currency type.

MoneyReflection

Holder for reflection information generated from google/type/money.proto

MonthReflection

Holder for reflection information generated from google/type/month.proto

PostalAddress

Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains).

In typical usage an address would be created via user input or from importing existing data, depending on the type of process.

Advice on address input / editing:

Use an i18n-ready address widget such as https://github.com/google/libaddressinput)
Users should not be presented with UI elements for input or editing of fields outside countries where that field is used.

For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478

PostalAddressReflection

Holder for reflection information generated from google/type/postal_address.proto

Quaternion

A quaternion is defined as the quotient of two directed lines in a three-dimensional space or equivalently as the quotient of two Euclidean vectors (https://en.wikipedia.org/wiki/Quaternion).

Quaternions are often used in calculations involving three-dimensional rotations (https://en.wikipedia.org/wiki/Quaternions_and_spatial_rotation), as they provide greater mathematical robustness by avoiding the gimbal lock problems that can be encountered when using Euler angles (https://en.wikipedia.org/wiki/Gimbal_lock).

Quaternions are generally represented in this form:

w + xi + yj + zk

where x, y, z, and w are real numbers, and i, j, and k are three imaginary numbers.

Our naming choice (x, y, z, w) comes from the desire to avoid confusion for those interested in the geometric properties of the quaternion in the 3D Cartesian space. Other texts often use alternative names or subscripts, such as (a, b, c, d), (1, i, j, k), or (0, 1, 2, 3), which are perhaps better suited for mathematical interpretations.

To avoid any confusion, as well as to maintain compatibility with a large number of software libraries, the quaternions represented using the protocol buffer below must follow the Hamilton convention, which defines ij = k (i.e. a right-handed algebra), and therefore:

i^2 = j^2 = k^2 = ijk = −1 ij = −ji = k jk = −kj = i ki = −ik = j

Please DO NOT use this to represent quaternions that follow the JPL convention, or any of the other quaternion flavors out there.

Definitions:

Quaternion norm (or magnitude): sqrt(x^2 + y^2 + z^2 + w^2).
Unit (or normalized) quaternion: a quaternion whose norm is 1.
Pure quaternion: a quaternion whose scalar component (w) is 0.
Rotation quaternion: a unit quaternion used to represent rotation.
Orientation quaternion: a unit quaternion used to represent orientation.

A quaternion can be normalized by dividing it by its norm. The resulting quaternion maintains the same direction, but has a norm of 1, i.e. it moves on the unit sphere. This is generally necessary for rotation and orientation quaternions, to avoid rounding errors: https://en.wikipedia.org/wiki/Rotation_formalisms_in_three_dimensions

Note that (x, y, z, w) and (-x, -y, -z, -w) represent the same rotation, but normalization would be even more useful, e.g. for comparison purposes, if it would produce a unique representation. It is thus recommended that w be kept positive, which can be achieved by changing all the signs when w is negative.

Namespace Google.Type (2.2.0)

Classes

CalendarPeriodReflection

Color

ColorReflection

Date

DateExtensions

DateReflection

DateTime

DatetimeReflection

DayofweekReflection

Expr

ExprReflection

Fraction

FractionReflection

LatLng

LatlngReflection

Money

MoneyReflection

MonthReflection

PostalAddress

PostalAddressReflection

Quaternion

QuaternionReflection

TimeOfDay

TimeofdayReflection

TimeZone

Enums

CalendarPeriod

DateTime.TimeOffsetOneofCase

DayOfWeek

Month