Package intrinsic_proto.product
Services
service ProductService intrinsic/scene/product/proto/product_service.proto
ProductService provides the means to work with products in a Solution.
rpc CreateProduct
Request: intrinsic_proto.product.CreateProductRequest
Response:
intrinsic_proto.product.Product
Creates a new product to be instantiated and adds it to the application.
rpc GetProduct
Request: intrinsic_proto.product.GetProductRequest
Response:
intrinsic_proto.product.Product
Gets a product.
rpc GetProductGeometry
Request: intrinsic_proto.product.GetProductGeometryRequest
Response:
intrinsic_proto.product.GetProductGeometryResponse
Gets the geometry representation of a product.
rpc UpdateProduct
Request: intrinsic_proto.product.UpdateProductRequest
Response:
intrinsic_proto.product.Product
Updates a product.
rpc DeleteProduct
Request: intrinsic_proto.product.DeleteProductRequest
Response:
google.protobuf.Empty
Deletes a product.
rpc ListProducts
Request: intrinsic_proto.product.ListProductsRequest
Response:
intrinsic_proto.product.ListProductsResponse
List all of the products currently in the Solution.
Messages
message CreateProductRequest intrinsic/scene/product/proto/product_service.proto
| Field | Type | Description | |
|---|---|---|---|
| 1 | name |
string
|
The name of the product. |
| 5 | default_product_config |
optional
intrinsic_proto.product.ProductConfig
|
The default product configuration. |
|
oneof spec
|
|||
| 2 | scene_file |
intrinsic_proto.product.ProductSceneFileData
|
The scene file to create the product from. |
| 3 | scene_object |
intrinsic_proto.scene_object.v1.SceneObject
|
The scene object to create the product from. |
| 4 | id_version |
intrinsic_proto.assets.IdVersion
|
The id version of the product to create from. |
| 6 | primitive |
intrinsic_proto.product.ProductFromPrimitive
|
The primitive to create the product from. |
message DeleteProductRequest intrinsic/scene/product/proto/product_service.proto
| Field | Type | Description | |
|---|---|---|---|
| 1 | name |
string
|
The name of the product to delete. |
message GetProductGeometryRequest intrinsic/scene/product/proto/product_service.proto
| Field | Type | Description | |
|---|---|---|---|
| 1 | name |
string
|
The name of the product to get. |
message GetProductGeometryResponse intrinsic/scene/product/proto/product_service.proto
| Field | Type | Description | |
|---|---|---|---|
| 1 | scene_object |
intrinsic_proto.scene_object.v1.SceneObject
|
The geometry representation of the product in the form of a SceneObject. |
message GetProductRequest intrinsic/scene/product/proto/product_service.proto
| Field | Type | Description | |
|---|---|---|---|
| 1 | name |
string
|
The name of the product to get. |
message ListProductsRequest intrinsic/scene/product/proto/product_service.proto
| Field | Type | Description |
|---|
message ListProductsResponse intrinsic/scene/product/proto/product_service.proto
| Field | Type | Description | |
|---|---|---|---|
| 1 | products |
repeated
intrinsic_proto.product.Product
|
message Product intrinsic/scene/product/proto/product.proto
A Product is a template instantiable in a Flowstate Solution. A product is composed from a geometry respresentation(SceneObject) and product configurations.
| Field | Type | Description | |
|---|---|---|---|
| 1 | name |
string
|
The name of the product. |
| 2 | default_config |
intrinsic_proto.product.ProductConfig
|
Default configuration for this Product. |
message ProductConfig intrinsic/scene/product/proto/product.proto
| Field | Type | Description | |
|---|---|---|---|
| 1 | metadata |
google.protobuf.Struct
|
metadata is a struct that a product can use to store arbitrary metadata. |
message ProductFromPrimitive intrinsic/scene/product/proto/product_service.proto
A primitive to create a product from.
| Field | Type | Description | |
|---|---|---|---|
|
oneof primitive
|
|||
| 1 | box |
intrinsic_proto.geometry.Box
|
|
| 2 | sphere |
intrinsic_proto.geometry.Sphere
|
|
| 3 | cylinder |
intrinsic_proto.geometry.Cylinder
|
|
| 4 | capsule |
intrinsic_proto.geometry.Capsule
|
|
| 5 | ellipsoid |
intrinsic_proto.geometry.Ellipsoid
|
|
message ProductSceneFileData intrinsic/scene/product/proto/product_service.proto
A scene file to create a product from.
| Field | Type | Description | |
|---|---|---|---|
| 1 | file_name |
string
|
Name of the file. |
| 2 | data |
bytes
|
The data of the file. |
message RenameProduct intrinsic/scene/product/proto/product_service.proto
| Field | Type | Description | |
|---|---|---|---|
| 1 | new_name |
string
|
The new name of the product. |
message UpdateProductGeometry intrinsic/scene/product/proto/product_service.proto
| Field | Type | Description | |
|---|---|---|---|
| 1 | scene_object_instance_updates |
intrinsic_proto.scene_object.v1.SceneObjectInstanceUpdates
|
// List of updates to the product geometry. |
message UpdateProductMetadata intrinsic/scene/product/proto/product_service.proto
| Field | Type | Description | |
|---|---|---|---|
| 1 | new_metadata |
google.protobuf.Struct
|
Replace existing metadata in product default config with this new metadata. |
message UpdateProductRequest intrinsic/scene/product/proto/product_service.proto
| Field | Type | Description | |
|---|---|---|---|
| 1 | name |
string
|
The name of the product to update. |
|
oneof update
|
|||
| 2 | rename_product |
intrinsic_proto.product.RenameProduct
|
|
| 3 | update_product_geometry |
intrinsic_proto.product.UpdateProductGeometry
|
|
| 4 | update_product_metadata |
intrinsic_proto.product.UpdateProductMetadata
|
|