carla/PythonAPI/docs/geom.yml

231 lines
5.5 KiB
YAML

---
- module_name: carla
doc: >
classes:
- class_name: Vector2D
# - DESCRIPTION ------------------------
doc: >
Vector 2D helper class
# - PROPERTIES -------------------------
instance_variables:
- var_name: x
doc: >
- var_name: 'y'
doc: >
# - METHODS ----------------------------
methods:
- def_name: __add__
params:
- param_name: self
- param_name: other
# --------------------------------------
- def_name: __mul__
params:
- param_name: self
- param_name: other
# --------------------------------------
- def_name: __sub__
params:
- param_name: self
- param_name: other
# --------------------------------------
- def_name: __truediv__
params:
- param_name: self
- param_name: other
# --------------------------------------
- def_name: __eq__
params:
- param_name: self
- param_name: other
# --------------------------------------
- def_name: __ne__
params:
- param_name: self
- param_name: other
# --------------------------------------
- class_name: Vector3D
# - DESCRIPTION ------------------------
doc: >
Vector 3D helper class
# - PROPERTIES -------------------------
instance_variables:
- var_name: x
doc: >
- var_name: 'y'
doc: >
- var_name: z
doc: >
# - METHODS ----------------------------
methods:
- def_name: __add__
params:
- param_name: self
- param_name: other
# --------------------------------------
- def_name: __mul__
params:
- param_name: self
- param_name: other
# --------------------------------------
- def_name: __sub__
params:
- param_name: self
- param_name: other
# --------------------------------------
- def_name: __truediv__
params:
- param_name: self
- param_name: other
# --------------------------------------
- def_name: __eq__
params:
- param_name: self
- param_name: other
# --------------------------------------
- def_name: __ne__
params:
- param_name: self
- param_name: other
# --------------------------------------
- class_name: Location
parent: carla.Vector3D
# - DESCRIPTION ------------------------
doc: >
Class that represents a location
# - PROPERTIES -------------------------
instance_variables:
- var_name: x
doc: >
- var_name: 'y'
doc: >
- var_name: z
doc: >
# - METHODS ----------------------------
methods:
- def_name: distance
params:
- param_name: self
doc: >
# --------------------------------------
- def_name: __eq__
params:
- param_name: self
doc: >
# --------------------------------------
- def_name: __ne__
params:
- param_name: self
doc: >
# --------------------------------------
- class_name: Rotation
# - DESCRIPTION ------------------------
doc: >
# - PROPERTIES -------------------------
instance_variables:
- var_name: pitch
doc: >
- var_name: yaw
doc: >
- var_name: roll
doc: >
# - METHODS ----------------------------
methods:
- def_name: get_forward_vector
params:
- param_name: self
doc: >
# --------------------------------------
- def_name: __eq__
params:
- param_name: self
doc: >
# --------------------------------------
- def_name: __ne__
params:
- param_name: self
doc: >
# --------------------------------------
- class_name: Transform
# - DESCRIPTION ------------------------
doc: >
# - PROPERTIES -------------------------
instance_variables:
- var_name: location
doc: >
- var_name: rotation
doc: >
# - METHODS ----------------------------
methods:
- def_name: transform
params:
- param_name: self
doc: >
# --------------------------------------
- def_name: get_forward_vector
params:
- param_name: self
doc: >
# --------------------------------------
- def_name: __eq__
params:
- param_name: self
doc: >
# --------------------------------------
- def_name: __ne__
params:
- param_name: self
doc: >
# --------------------------------------
- class_name: BoundingBox
# - DESCRIPTION ------------------------
doc: >
# - PROPERTIES -------------------------
instance_variables:
- var_name: location
doc: >
- var_name: extent
doc: >
# - METHODS ----------------------------
methods:
- def_name: __eq__
params:
- param_name: self
doc: >
# --------------------------------------
- def_name: __ne__
params:
- param_name: self
doc: >
# --------------------------------------
- class_name: GeoLocation
# - DESCRIPTION ------------------------
doc: >
# - PROPERTIES -------------------------
instance_variables:
- var_name: latitude
doc: >
- var_name: longitude
doc: >
- var_name: altitude
doc: >
# - METHODS ----------------------------
methods:
- def_name: __eq__
params:
- param_name: self
doc: >
# --------------------------------------
- def_name: __ne__
params:
- param_name: self
doc: >
# --------------------------------------
...