BrushFamily
-
Cmn
class BrushFamily
A BrushFamily describes a family of brushes (e.g. “highlighter” or “pressure pen”), irrespective of their size or color. It can be thought of as roughly analogous to a font family.
BrushFamily objects are immutable.
Summary
Nested types |
|---|
class BrushFamily.BuilderBuilder for |
object BrushFamily.Companion |
abstract class BrushFamily.InputModelSpecifies a model for turning a sequence of raw hardware inputs (e.g. from a stylus, touchscreen, or mouse) into a sequence of smoothed, modeled inputs. |
|
An |
Public companion functions |
||
|---|---|---|
BrushFamily.Builder |
builder()Returns a new |
Cmn
|
Public constructors |
|
|---|---|
BrushFamily(Creates a |
Cmn
|
BrushFamily(Creates a |
Cmn
|
Public functions |
||
|---|---|---|
Version |
Returns the minimum required |
Cmn
|
BrushFamily |
copy(Creates a copy of |
Cmn
|
BrushFamily |
copy(Creates a copy of |
Cmn
|
BrushFamily |
copy(Creates a copy of |
Cmn
|
open operator Boolean |
Cmn
|
|
open Int |
hashCode() |
Cmn
|
BrushFamily.Builder |
Returns a |
Cmn
|
open String |
toString() |
Cmn
|
Public properties |
||
|---|---|---|
List<BrushCoat> |
An immutable list of the |
Cmn
|
String |
A multi-line, human-readable string with a description of the brush and how it works, with the intended audience being designers/developers who are editing the brush definition. |
Cmn
|
BrushFamily.InputModel |
The |
Cmn
|
Extension functions |
||
|---|---|---|
Unit |
BrushFamily.encode(Write a gzip-compressed |
android
|
Unit |
BrushFamily.encode(output: OutputStream)Write a gzip-compressed serialized |
android
|
Public companion functions
Public constructors
BrushFamily
BrushFamily(
coats: List<BrushCoat>,
inputModel: BrushFamily.InputModel = InputModel.DEFAULT_INPUT_MODEL,
developerComment: String = ""
)
Creates a BrushFamily with the given BrushCoats.
| Parameters | |
|---|---|
coats: List<BrushCoat> |
The |
inputModel: BrushFamily.InputModel = InputModel.DEFAULT_INPUT_MODEL |
The |
developerComment: String = "" |
A non-user-facing human-readable description of the brush family. |
BrushFamily
BrushFamily(
tip: BrushTip = BrushTip(),
paint: BrushPaint = BrushPaint(),
inputModel: BrushFamily.InputModel = InputModel.DEFAULT_INPUT_MODEL,
developerComment: String = ""
)
Creates a BrushFamily with a single BrushCoat that consists of the given BrushTip and BrushPaint.
| Parameters | |
|---|---|
tip: BrushTip = BrushTip() |
The |
paint: BrushPaint = BrushPaint() |
The |
inputModel: BrushFamily.InputModel = InputModel.DEFAULT_INPUT_MODEL |
The |
developerComment: String = "" |
A non-user-facing human-readable description of the brush family. |
Public functions
calculateMinimumRequiredVersion
fun calculateMinimumRequiredVersion(): Version
Returns the minimum required Version for this BrushFamily.
By default, decoding a BrushFamily with a minimum required version higher than Version.MAX_SUPPORTED will fail.
copy
fun copy(
coat: BrushCoat,
inputModel: BrushFamily.InputModel = this.inputModel,
developerComment: String = this.developerComment
): BrushFamily
Creates a copy of this and allows named properties to be altered while keeping the rest unchanged.
Java callers should use Builder instead.
copy
fun copy(
coats: List<BrushCoat> = this.coats,
inputModel: BrushFamily.InputModel = this.inputModel,
developerComment: String = this.developerComment
): BrushFamily
Creates a copy of this and allows named properties to be altered while keeping the rest unchanged.
Java callers should use Builder instead.
copy
fun copy(
tip: BrushTip,
paint: BrushPaint,
inputModel: BrushFamily.InputModel = this.inputModel,
developerComment: String = this.developerComment
): BrushFamily
Creates a copy of this and allows named properties to be altered while keeping the rest unchanged.
Java callers should use Builder instead.
toBuilder
fun toBuilder(): BrushFamily.Builder
Returns a Builder with values set equivalent to this. Java developers, use the returned builder to build a copy of a BrushFamily.
Public properties
developerComment
val developerComment: String
A multi-line, human-readable string with a description of the brush and how it works, with the intended audience being designers/developers who are editing the brush definition. This string is not generally intended to be displayed to end users.
inputModel
val inputModel: BrushFamily.InputModel
The InputModel that will be used by a Brush in this BrushFamily.
Extension functions
BrushFamily.encode
fun BrushFamily.encode(
output: OutputStream,
textureBitmapStore: TextureBitmapStore
): Unit
Write a gzip-compressed ink.proto.BrushFamily binary proto message representing the BrushFamily to the given OutputStream. If hasFallbacks is true, then the stored, proto message including fallbacks for this BrushFamily will be used instead of recomputing the proto from the BrushFamily object.
| Parameters | |
|---|---|
BrushFamily |
The |
output: OutputStream |
The |
textureBitmapStore: TextureBitmapStore |
The |
BrushFamily.encode
fun BrushFamily.encode(output: OutputStream): Unit
Write a gzip-compressed serialized ink.proto.BrushFamily proto message representing the BrushFamily to the given OutputStream. If BrushFamily.hasFallbacks is true, then the stored proto message including fallbacks for this BrushFamily will be used instead of recomputing the proto from the BrushFamily object.