Class: Geometry
protocol.Geometry
Represents a Geometry.
Implements
Constructors
constructor
• new Geometry(properties?): Geometry
Constructs a new Geometry.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IGeometry | Properties to set |
Returns
Properties
_faceName
• Optional _faceName: "faceName"
Geometry _faceName.
at
• at: number[]
Geometry at.
Implementation of
faceName
• Optional faceName: string
Geometry faceName.
Implementation of
indices
• indices: number[]
Geometry indices.
Implementation of
lights
• lights: number[]
Geometry lights.
Implementation of
positions
• positions: number[]
Geometry positions.
Implementation of
uvs
• uvs: number[]
Geometry uvs.
Implementation of
voxel
• voxel: number
Geometry voxel.
Implementation of
Methods
create
▸ create(properties?): Geometry
Creates a new Geometry instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IGeometry | Properties to set |
Returns
Geometry instance
decode
▸ decode(reader, length?): Geometry
Decodes a Geometry message from the specified reader or buffer.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Reader | Uint8Array | Reader or buffer to decode from |
length? | number | Message length if known beforehand |
Returns
Geometry
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): Geometry
Decodes a Geometry message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Reader | Uint8Array | Reader or buffer to decode from |
Returns
Geometry
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
encode
▸ encode(message, writer?): Writer
Encodes the specified Geometry message. Does not implicitly verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IGeometry | Geometry message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified Geometry message, length delimited. Does not implicitly verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IGeometry | Geometry message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): Geometry
Creates a Geometry message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
Geometry
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for Geometry
Parameters
| Name | Type | Description |
|---|---|---|
typeUrlPrefix? | string | your custom typeUrlPrefix(default "type.googleapis.com") |
Returns
string
The default type url
toJSON
▸ toJSON(): Object
Converts this Geometry to JSON.
Returns
Object
JSON object
toObject
▸ toObject(message, options?): Object
Creates a plain object from a Geometry message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | Geometry | Geometry |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object
verify
▸ verify(message): string
Verifies a Geometry message.
Parameters
| Name | Type | Description |
|---|---|---|
message | Object | Plain object to verify |
Returns
string
null if valid, otherwise the reason why it is not