Skip to main content

AVxcelerate Asset Preparation API 2024 R2

asset_preparation::v3::common Namespace Reference

Last update: 16.07.2025

Classes

struct  Chunk
 A block of data. More...
 
struct  Empty
 An empty message used for none type. More...
 
struct  Properties
 The properties of a tag. More...
 
struct  Status
 A status message informing about the success of a request. More...
 
struct  Tag
 The definition of a tag. More...
 
struct  TagIdentity
 The identity of a tag. More...
 

Enumerations

enum  ConflictPolicy {
  CONFLICT_POLICY_UNSPECIFIED = 0, CONFLICT_POLICY_STOP = 1, CONFLICT_POLICY_KEEP_EXISTING = 2, CONFLICT_POLICY_OVERRIDE = 3,
  CONFLICT_POLICY_KEEP_BOTH = 4
}
 The conflict policy to define what should be imported when there is any name conflict detected between objects from the environment or scene tree to import and the objects already existing on the server. More...
 
enum  Level { LEVEL_UNSPECIFIED = 0, LEVEL_ERROR = 1, LEVEL_WARNING = 2, LEVEL_INFORMATION = 3 }
 The severity of the feedback on an operation. More...
 
enum  BasicType {
  BASIC_TYPE_UNSPECIFIED = 0, BASIC_TYPE_PEDESTRIAN = 1, BASIC_TYPE_VEHICLE = 2, BASIC_TYPE_ANIMAL = 3,
  BASIC_TYPE_STREET_LIGHT = 4, BASIC_TYPE_ROAD_SIGN = 5, BASIC_TYPE_SIMULATION_OBJECT = 6, BASIC_TYPE_CUSTOM_OBJECT = 7,
  BASIC_TYPE_VEHICLE_BODY = 8, BASIC_TYPE_SENSOR_REFERENTIAL = 9, BASIC_TYPE_LIGHTING_SYSTEM_REFERENTIAL = 10, BASIC_TYPE_WHEEL = 11,
  BASIC_TYPE_STEERING_WHEEL = 12
}
 Types for a basic element tag. More...
 
enum  LightingType {
  LIGHTING_TYPE_UNSPECIFIED = 0, LIGHTING_TYPE_BRAKE_LIGHT = 1, LIGHTING_TYPE_LOW_BEAM = 2, LIGHTING_TYPE_HIGH_BEAM = 3,
  LIGHTING_TYPE_TURN_INDICATOR = 4, LIGHTING_TYPE_REAR_FOG_LIGHT = 5, LIGHTING_TYPE_FRONT_FOG_LIGHT = 6, LIGHTING_TYPE_SIDE_LIGHT = 7,
  LIGHTING_TYPE_REAR_POSITION_LIGHT = 8, LIGHTING_TYPE_REVERSE_LIGHT = 9, LIGHTING_TYPE_LICENSE_PLATE_LIGHT = 10, LIGHTING_TYPE_DAYTIME_RUNNING_LIGHT = 11
}
 Types for a lighting element tag. More...
 
enum  SidePosition { SIDE_POSITION_UNSPECIFIED = 0, SIDE_POSITION_LEFT = 1, SIDE_POSITION_RIGHT = 2 }
 The position of the lighting element. More...
 

Variables

import google protobuf wrappers proto
 

Enumeration Type Documentation

◆ ConflictPolicy

The conflict policy to define what should be imported when there is any name conflict detected between objects from the environment or scene tree to import and the objects already existing on the server.

Enumerator
CONFLICT_POLICY_UNSPECIFIED 

Unspecified conflict policy.

CONFLICT_POLICY_STOP 

The import operation is canceled when there is a conflict with the server's objects.

Note
This is the default behavior when no policy is specified.
CONFLICT_POLICY_KEEP_EXISTING 

When there is a conflict with the server's objects, the import operation continues without importing the conflicting objects. The already existing objects are used in the imported environment/scene tree.

CONFLICT_POLICY_OVERRIDE 

When there is a conflict with the server's objects, the import operation continues and the objects from the imported environment/scene tree override the already existing objects.

CONFLICT_POLICY_KEEP_BOTH 

When there is a conflict with the server's objects, the import operation continues and both conflicting objects are kept: the objects already existing remains on the server and the objects coming from the import operation are automatically renamed and used in the imported environment/scene tree.

◆ Level

The severity of the feedback on an operation.

Enumerator
LEVEL_UNSPECIFIED 

The severity is unspecified.

LEVEL_ERROR 

The operation returned an error.

LEVEL_WARNING 

The operation succeeded with warnings.

LEVEL_INFORMATION 

The operation fully succeeded.

◆ BasicType

Types for a basic element tag.

Enumerator
BASIC_TYPE_UNSPECIFIED 

The basic tag type is unspecified.

BASIC_TYPE_PEDESTRIAN 

The element is tagged as a pedestrian.

BASIC_TYPE_VEHICLE 

The element is tagged as a vehicle.

BASIC_TYPE_ANIMAL 

The element is tagged as an animal.

BASIC_TYPE_STREET_LIGHT 

The element is tagged as a street light.

BASIC_TYPE_ROAD_SIGN 

The element is tagged as a road sign.

BASIC_TYPE_SIMULATION_OBJECT 

The element is tagged as a simulation object.

BASIC_TYPE_CUSTOM_OBJECT 

The element is tagged as a custom simulation object.

Note
If you want to tag a dynamic asset as a custom simulation object, you must add the custom tag first, then add a second asset tag: BASIC_TYPE_VEHICLE, BASIC_TYPE_PEDESTRIAN or BASIC_TYPE_ANIMAL, in this specific order.
BASIC_TYPE_VEHICLE_BODY 

The element is tagged as a vehicle body.

BASIC_TYPE_SENSOR_REFERENTIAL 

The element is tagged as the sensor referential of a vehicle.

BASIC_TYPE_LIGHTING_SYSTEM_REFERENTIAL 

The element is tagged as the lighting system referential of a vehicle.

BASIC_TYPE_WHEEL 

The element is tagged as a wheel of a vehicle.

BASIC_TYPE_STEERING_WHEEL 

The element is tagged as the steering wheel of a vehicle.

◆ LightingType

Types for a lighting element tag.

Enumerator
LIGHTING_TYPE_UNSPECIFIED 

The lighting tag type is unspecified.

LIGHTING_TYPE_BRAKE_LIGHT 

The lighting element is tagged as a brake light.

LIGHTING_TYPE_LOW_BEAM 

The lighting element is tagged as a low beam.

LIGHTING_TYPE_HIGH_BEAM 

The lighting element is tagged as a high beam.

LIGHTING_TYPE_TURN_INDICATOR 

The lighting element is tagged as a turn indicator.

LIGHTING_TYPE_REAR_FOG_LIGHT 

The lighting element is tagged as a rear fog light.

LIGHTING_TYPE_FRONT_FOG_LIGHT 

The lighting element is tagged as a front fog light.

LIGHTING_TYPE_SIDE_LIGHT 

The lighting element is tagged as a side light.

LIGHTING_TYPE_REAR_POSITION_LIGHT 

The lighting element is tagged as a rear position light.

LIGHTING_TYPE_REVERSE_LIGHT 

The lighting element is tagged as a reverse light.

LIGHTING_TYPE_LICENSE_PLATE_LIGHT 

The lighting element is tagged as a license plate light.

LIGHTING_TYPE_DAYTIME_RUNNING_LIGHT 

The lighting element is tagged as a daytime running light.

◆ SidePosition

The position of the lighting element.

Note
Needed only for the tags with the LIGHTING_TYPE_TURN_INDICATOR and LIGHTING_TYPE_DAYTIME_RUNNING_LIGHT types.
Enumerator
SIDE_POSITION_UNSPECIFIED 

The position of the lighting element is unspecified.

SIDE_POSITION_LEFT 

The lighting element is on the left side of the vehicle.

SIDE_POSITION_RIGHT 

The lighting element is on the right side of the vehicle.

Variable Documentation

◆ proto

import google protobuf wrappers asset_preparation::v3::common::proto

Connect with Ansys