Package com.google.type
Class Color.Builder
- java.lang.Object
-
- com.google.protobuf.AbstractMessageLite.Builder
-
- com.google.protobuf.AbstractMessage.Builder<BuilderType>
-
- com.google.protobuf.GeneratedMessageV3.Builder<Color.Builder>
-
- com.google.type.Color.Builder
-
- All Implemented Interfaces:
com.google.protobuf.Message.Builder,com.google.protobuf.MessageLite.Builder,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,ColorOrBuilder,Cloneable
- Enclosing class:
- Color
public static final class Color.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<Color.Builder> implements ColorOrBuilder
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. This reference page doesn't 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. When color equality needs to be decided, implementations, unless documented otherwise, treat two colors as equal if all their red, green, blue, and alpha values each differ by at most 1e-5. 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(''); }; // ...Protobuf typegoogle.type.Color
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Color.BuilderaddRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)Colorbuild()ColorbuildPartial()Color.Builderclear()Color.BuilderclearAlpha()The fraction of this color that should be applied to the pixel.Color.BuilderclearBlue()The amount of blue in the color as a value in the interval [0, 1].Color.BuilderclearField(com.google.protobuf.Descriptors.FieldDescriptor field)Color.BuilderclearGreen()The amount of green in the color as a value in the interval [0, 1].Color.BuilderclearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)Color.BuilderclearRed()The amount of red in the color as a value in the interval [0, 1].Color.Builderclone()com.google.protobuf.FloatValuegetAlpha()The fraction of this color that should be applied to the pixel.com.google.protobuf.FloatValue.BuildergetAlphaBuilder()The fraction of this color that should be applied to the pixel.com.google.protobuf.FloatValueOrBuildergetAlphaOrBuilder()The fraction of this color that should be applied to the pixel.floatgetBlue()The amount of blue in the color as a value in the interval [0, 1].ColorgetDefaultInstanceForType()static com.google.protobuf.Descriptors.DescriptorgetDescriptor()com.google.protobuf.Descriptors.DescriptorgetDescriptorForType()floatgetGreen()The amount of green in the color as a value in the interval [0, 1].floatgetRed()The amount of red in the color as a value in the interval [0, 1].booleanhasAlpha()The fraction of this color that should be applied to the pixel.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()booleanisInitialized()Color.BuildermergeAlpha(com.google.protobuf.FloatValue value)The fraction of this color that should be applied to the pixel.Color.BuildermergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)Color.BuildermergeFrom(com.google.protobuf.Message other)Color.BuildermergeFrom(Color other)Color.BuildermergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)Color.BuildersetAlpha(com.google.protobuf.FloatValue value)The fraction of this color that should be applied to the pixel.Color.BuildersetAlpha(com.google.protobuf.FloatValue.Builder builderForValue)The fraction of this color that should be applied to the pixel.Color.BuildersetBlue(float value)The amount of blue in the color as a value in the interval [0, 1].Color.BuildersetField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)Color.BuildersetGreen(float value)The amount of green in the color as a value in the interval [0, 1].Color.BuildersetRed(float value)The amount of red in the color as a value in the interval [0, 1].Color.BuildersetRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)Color.BuildersetUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)-
Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3
-
Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString
-
Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException
-
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
-
-
-
Method Detail
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessageV3.Builder<Color.Builder>
-
clear
public Color.Builder clear()
- Specified by:
clearin interfacecom.google.protobuf.Message.Builder- Specified by:
clearin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
clearin classcom.google.protobuf.GeneratedMessageV3.Builder<Color.Builder>
-
getDescriptorForType
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.Message.Builder- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.MessageOrBuilder- Overrides:
getDescriptorForTypein classcom.google.protobuf.GeneratedMessageV3.Builder<Color.Builder>
-
getDefaultInstanceForType
public Color getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-
build
public Color build()
- Specified by:
buildin interfacecom.google.protobuf.Message.Builder- Specified by:
buildin interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
public Color buildPartial()
- Specified by:
buildPartialin interfacecom.google.protobuf.Message.Builder- Specified by:
buildPartialin interfacecom.google.protobuf.MessageLite.Builder
-
clone
public Color.Builder clone()
- Specified by:
clonein interfacecom.google.protobuf.Message.Builder- Specified by:
clonein interfacecom.google.protobuf.MessageLite.Builder- Overrides:
clonein classcom.google.protobuf.GeneratedMessageV3.Builder<Color.Builder>
-
setField
public Color.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
- Specified by:
setFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
setFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<Color.Builder>
-
clearField
public Color.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
- Specified by:
clearFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
clearFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<Color.Builder>
-
clearOneof
public Color.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
- Specified by:
clearOneofin interfacecom.google.protobuf.Message.Builder- Overrides:
clearOneofin classcom.google.protobuf.GeneratedMessageV3.Builder<Color.Builder>
-
setRepeatedField
public Color.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
- Specified by:
setRepeatedFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
setRepeatedFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<Color.Builder>
-
addRepeatedField
public Color.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
- Specified by:
addRepeatedFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
addRepeatedFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<Color.Builder>
-
mergeFrom
public Color.Builder mergeFrom(com.google.protobuf.Message other)
- Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<Color.Builder>
-
mergeFrom
public Color.Builder mergeFrom(Color other)
-
isInitialized
public final boolean isInitialized()
- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessageV3.Builder<Color.Builder>
-
mergeFrom
public Color.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
- Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Specified by:
mergeFromin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<Color.Builder>- Throws:
IOException
-
getRed
public float getRed()
The amount of red in the color as a value in the interval [0, 1].
float red = 1;- Specified by:
getRedin interfaceColorOrBuilder- Returns:
- The red.
-
setRed
public Color.Builder setRed(float value)
The amount of red in the color as a value in the interval [0, 1].
float red = 1;- Parameters:
value- The red to set.- Returns:
- This builder for chaining.
-
clearRed
public Color.Builder clearRed()
The amount of red in the color as a value in the interval [0, 1].
float red = 1;- Returns:
- This builder for chaining.
-
getGreen
public float getGreen()
The amount of green in the color as a value in the interval [0, 1].
float green = 2;- Specified by:
getGreenin interfaceColorOrBuilder- Returns:
- The green.
-
setGreen
public Color.Builder setGreen(float value)
The amount of green in the color as a value in the interval [0, 1].
float green = 2;- Parameters:
value- The green to set.- Returns:
- This builder for chaining.
-
clearGreen
public Color.Builder clearGreen()
The amount of green in the color as a value in the interval [0, 1].
float green = 2;- Returns:
- This builder for chaining.
-
getBlue
public float getBlue()
The amount of blue in the color as a value in the interval [0, 1].
float blue = 3;- Specified by:
getBluein interfaceColorOrBuilder- Returns:
- The blue.
-
setBlue
public Color.Builder setBlue(float value)
The amount of blue in the color as a value in the interval [0, 1].
float blue = 3;- Parameters:
value- The blue to set.- Returns:
- This builder for chaining.
-
clearBlue
public Color.Builder clearBlue()
The amount of blue in the color as a value in the interval [0, 1].
float blue = 3;- Returns:
- This builder for chaining.
-
hasAlpha
public boolean hasAlpha()
The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is rendered as a solid color (as if the alpha value had been explicitly given a value of 1.0).
.google.protobuf.FloatValue alpha = 4;- Specified by:
hasAlphain interfaceColorOrBuilder- Returns:
- Whether the alpha field is set.
-
getAlpha
public com.google.protobuf.FloatValue getAlpha()
The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is rendered as a solid color (as if the alpha value had been explicitly given a value of 1.0).
.google.protobuf.FloatValue alpha = 4;- Specified by:
getAlphain interfaceColorOrBuilder- Returns:
- The alpha.
-
setAlpha
public Color.Builder setAlpha(com.google.protobuf.FloatValue value)
The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is rendered as a solid color (as if the alpha value had been explicitly given a value of 1.0).
.google.protobuf.FloatValue alpha = 4;
-
setAlpha
public Color.Builder setAlpha(com.google.protobuf.FloatValue.Builder builderForValue)
The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is rendered as a solid color (as if the alpha value had been explicitly given a value of 1.0).
.google.protobuf.FloatValue alpha = 4;
-
mergeAlpha
public Color.Builder mergeAlpha(com.google.protobuf.FloatValue value)
The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is rendered as a solid color (as if the alpha value had been explicitly given a value of 1.0).
.google.protobuf.FloatValue alpha = 4;
-
clearAlpha
public Color.Builder clearAlpha()
The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is rendered as a solid color (as if the alpha value had been explicitly given a value of 1.0).
.google.protobuf.FloatValue alpha = 4;
-
getAlphaBuilder
public com.google.protobuf.FloatValue.Builder getAlphaBuilder()
The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is rendered as a solid color (as if the alpha value had been explicitly given a value of 1.0).
.google.protobuf.FloatValue alpha = 4;
-
getAlphaOrBuilder
public com.google.protobuf.FloatValueOrBuilder getAlphaOrBuilder()
The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is rendered as a solid color (as if the alpha value had been explicitly given a value of 1.0).
.google.protobuf.FloatValue alpha = 4;- Specified by:
getAlphaOrBuilderin interfaceColorOrBuilder
-
setUnknownFields
public final Color.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
- Specified by:
setUnknownFieldsin interfacecom.google.protobuf.Message.Builder- Overrides:
setUnknownFieldsin classcom.google.protobuf.GeneratedMessageV3.Builder<Color.Builder>
-
mergeUnknownFields
public final Color.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
- Specified by:
mergeUnknownFieldsin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeUnknownFieldsin classcom.google.protobuf.GeneratedMessageV3.Builder<Color.Builder>
-
-