Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[BE] - Fix typos in bindings and stubs. #2535

Merged
merged 1 commit into from
Jan 21, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions src/esp/bindings/AttributesBindings.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -209,7 +209,7 @@ void initAttributesBindings(py::module& m) {
"object for rendering.");
//
// ==== AssetType ====
// Describes the type of asset used for rendering, collsions, or semantics
// Describes the type of asset used for rendering, collisions, or semantics
py::enum_<metadata::attributes::AssetType>(m, "AssetType")
.value("UNKNOWN", metadata::attributes::AssetType::Unknown)
.value("MP3D", metadata::attributes::AssetType::Mp3dMesh)
Expand Down Expand Up @@ -552,7 +552,7 @@ void initAttributesBindings(py::module& m) {
.def_property(
"inertia_source", &ArticulatedObjectAttributes::getInertiaSource,
&ArticulatedObjectAttributes::setInertiaSource,
R"(Tthe source of the inertia tensors to use for this Articulated Object.
R"(The source of the inertia tensors to use for this Articulated Object.
Possible values are "COMPUTED" and "URDF".)")
.def_property(
"link_order", &ArticulatedObjectAttributes::getLinkOrder,
Expand Down Expand Up @@ -581,7 +581,7 @@ void initAttributesBindings(py::module& m) {
"collision_asset_size",
&AbstractObjectAttributes::getCollisionAssetSize,
&AbstractObjectAttributes::setCollisionAssetSize,
R"(Size of collsion assets for constructions built from this template in
R"(Size of collision assets for constructions built from this template in
x,y,z. Default is [1.0,1.0,1.0]. This is used to resize a collision asset
to match a render asset if necessary, such as when using a primitive.)")
.def_property(
Expand Down Expand Up @@ -642,7 +642,7 @@ void initAttributesBindings(py::module& m) {
"collision_asset_handle",
&AbstractObjectAttributes::getCollisionAssetHandle,
&AbstractObjectAttributes::setCollisionAssetHandle,
R"(Handle of the asset used to calculate collsions for constructions
R"(Handle of the asset used to calculate collisions for constructions
built from this template.)")
.def_property_readonly(
"render_asset_fullpath",
Expand All @@ -653,7 +653,7 @@ void initAttributesBindings(py::module& m) {
.def_property_readonly(
"collision_asset_fullpath",
&AbstractObjectAttributes::getCollisionAssetFullPath,
R"(Fully qualified filepath of the asset used to calculate collsions for constructions
R"(Fully qualified filepath of the asset used to calculate collisions for constructions
built from this template. This filepath will only be available/accurate
after the owning attributes is registered)")
.def_property(
Expand Down Expand Up @@ -709,7 +709,7 @@ void initAttributesBindings(py::module& m) {
.def_property(
"inertia", &ObjectAttributes::getInertia,
&ObjectAttributes::setInertia,
R"(The diagonal of the Intertia matrix for objects constructed
R"(The diagonal of the inertia matrix for objects constructed
from this template.)")
.def_property(
"linear_damping", &ObjectAttributes::getLinearDamping,
Expand Down Expand Up @@ -784,7 +784,7 @@ void initAttributesBindings(py::module& m) {
[](LightInstanceAttributes& self, Mn::Radd rads) {
self.setOuterConeAngle(static_cast<Mn::Rad>(rads));
},
R"(The outter cone angle to use for the dispersion of spot lights.
R"(The outer cone angle to use for the dispersion of spot lights.
Ignored for other types of lights.)");

// ==== LightLayoutAttributes ====
Expand Down Expand Up @@ -972,7 +972,7 @@ void initAttributesBindings(py::module& m) {
PhysicsManagerAttributes::ptr>(
m, "PhysicsManagerAttributes",
R"(A metadata template for Simulation parameters (e.g. timestep, simulation backend,
default gravity direction) and defaults. Consumed to instace a Simulator object.
default gravity direction) and defaults. Consumed to instance a Simulator object.
Is imported from .physics_config.json files.)")
.def(py::init(&PhysicsManagerAttributes::create<>))
.def(py::init(&PhysicsManagerAttributes::create<const std::string&>))
Expand Down
4 changes: 2 additions & 2 deletions src/esp/bindings/AttributesManagersBindings.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -338,8 +338,8 @@ void initAttributesManagersBindings(py::module& m) {
ManagedObjectAccess::Copy>,
AssetAttributesManager::ptr>(
m, "AssetAttributesManager",
R"(Manages PrimtiveAttributes objects which define parameters for constructing primitive mesh shapes such as cubes, capsules, cylinders, and cones.)")
// AssetAttributesMangaer-specific bindings
R"(Manages PrimitiveAttributes objects which define parameters for constructing primitive mesh shapes such as cubes, capsules, cylinders, and cones.)")
// AssetAttributesManager-specific bindings
// return appropriately cast capsule templates
.def("get_default_capsule_template",
&AssetAttributesManager::getDefaultCapsuleTemplate,
Expand Down
2 changes: 1 addition & 1 deletion src/esp/bindings/GeoBindings.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ void initGeoBindings(py::module& m) {
"build_catmull_rom_spline", &geo::buildCatmullRomTrajOfPoints,
R"(This function builds an interpolating Catmull-Rom spline through the passed list of
key points, with num_interpolations interpolated points between each key point, and
alpha [0,1] deteriming the nature of the spline (default is .5) :
alpha [0,1] determining the nature of the spline (default is .5) :
0.0 is a standard Catmull-Rom spline (which may have cusps)
0.5 is a centripetal Catmull-Rom spline
1.0 is a chordal Catmull-Rom spline)",
Expand Down
2 changes: 1 addition & 1 deletion src/esp/bindings/GfxBindings.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -266,7 +266,7 @@ void initGfxBindings(
R"(Draw a set of coordinate axes at the given XYZ translation and with
XYZ scaling in world-space or local-space (see pushTransform).
These axes are color-mapped such that XYZ->RGB and each positive axis
as a connical 'arrow head' of given radius.)",
as a conical 'arrow head' of given radius.)",
"translation"_a, "scale"_a = Magnum::Vector3{1.0, 1.0, 1.0},
"radius"_a = 0.05)
.def(
Expand Down
2 changes: 1 addition & 1 deletion src/esp/bindings/MetadataMediatorBindings.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ namespace metadata {
void initMetadataMediatorBindings(py::module& m) {
py::class_<MetadataMediator, MetadataMediator::ptr>(
m, "MetadataMediator",
R"(Aggregates all AttributesManagers and provides an API for swapping the active SceneDataset. It can exist independant of a :ref:`Simulator` object for programmatic metadata management and can be passed into the constructor via the :ref:`SimulatorConfiguration`.)")
R"(Aggregates all AttributesManagers and provides an API for swapping the active SceneDataset. It can exist independently of a :ref:`Simulator` object for programmatic metadata management and can be passed into the constructor via the :ref:`SimulatorConfiguration`.)")
.def(py::init(&MetadataMediator::create<>))
.def(py::init<const sim::SimulatorConfiguration&>())
.def_property(
Expand Down
2 changes: 1 addition & 1 deletion src/esp/bindings/SensorBindings.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -372,7 +372,7 @@ void initSensorBindings(py::module& m) {
R"(bool | false | Turn on/off temporal smoothing of the impulse response. This uses the impulse response from the previous simulation time step as a starting point for the next time step. This reduces the number of rays required by about a factor of 10, resulting in faster simulations, but should not be used if the motion of sources/listeners is not continuous.)")
.def_readwrite(
"dumpWaveFiles", &RLRAudioPropagation::Configuration::dumpWaveFiles,
R"(bool | false | Write the wave files for different bands. Will be writted to the AudioSensorSpec's outputDirectory)")
R"(bool | false | Write the wave files for different bands. Will be written to the AudioSensorSpec's outputDirectory)")
.def_readwrite("enableMaterials",
&RLRAudioPropagation::Configuration::enableMaterials,
R"(bool | true | Enable audio materials)")
Expand Down
10 changes: 5 additions & 5 deletions src/esp/bindings/ShortestPathBindings.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -100,10 +100,10 @@ void initShortestPathBindings(py::module& m) {
R"(Region merge size in voxels. regionMergeSize = sqrt(regionMergeArea) Any 2-D regions with a smaller span (cell count) will, if possible, be merged with larger regions.)")
.def_readwrite(
"edge_max_len", &NavMeshSettings::edgeMaxLen,
R"(Edge max length in world units. The maximum allowed length for contour edges along the border of the mesh. Extra vertices will be inserted as needed to keep contour edges below this length. A value of zero effectively disables this feature. A good value for edgeMaxLen is something like agenRadius*8. Will be rounded to a multiple of cellSize.)")
R"(Edge max length in world units. The maximum allowed length for contour edges along the border of the mesh. Extra vertices will be inserted as needed to keep contour edges below this length. A value of zero effectively disables this feature. A good value for edgeMaxLen is something like agentRadius*8. Will be rounded to a multiple of cellSize.)")
.def_readwrite(
"edge_max_error", &NavMeshSettings::edgeMaxError,
R"(The maximum distance a simplfied contour's border edges should deviate the original raw contour. Good values are between 1.1-1.5 (1.3 usually yield good results). More results in jaggies, less cuts corners.)")
R"(The maximum distance a simplified contour's border edges should deviate the original raw contour. Good values are between 1.1-1.5 (1.3 usually yield good results). More results in jaggies, less cuts corners.)")
.def_readwrite(
"verts_per_poly", &NavMeshSettings::vertsPerPoly,
R"(The maximum number of vertices allowed for polygons generated during the contour to polygon conversion process. [Limit: >= 3])")
Expand All @@ -116,14 +116,14 @@ void initShortestPathBindings(py::module& m) {
.def_readwrite(
"filter_low_hanging_obstacles",
&NavMeshSettings::filterLowHangingObstacles,
R"(Marks navigable spans as non-navigable if the clearence above the span is less than the specified height. Default True.)")
R"(Marks navigable spans as non-navigable if the clearance above the span is less than the specified height. Default True.)")
.def_readwrite(
"filter_ledge_spans", &NavMeshSettings::filterLedgeSpans,
R"(Marks spans that are ledges as non-navigable. This filter reduces the impact of the overestimation of conservative voxelization so the resulting mesh will not have regions hanging in the air over ledges. Default True.)")
.def_readwrite(
"filter_walkable_low_height_spans",
&NavMeshSettings::filterWalkableLowHeightSpans,
R"(Marks navigable spans as non-navigable if the clearence above the span is less than the specified height. Allows the formation of navigable regions that will flow over low lying objects such as curbs, and up structures such as stairways. Default True.)")
R"(Marks navigable spans as non-navigable if the clearance above the span is less than the specified height. Allows the formation of navigable regions that will flow over low lying objects such as curbs, and up structures such as stairways. Default True.)")
.def_readwrite(
"include_static_objects", &NavMeshSettings::includeStaticObjects,
R"(Whether or not to include STATIC RigidObjects as NavMesh constraints. Note: Used in Simulator recomputeNavMesh pre-process. Default False.)")
Expand Down Expand Up @@ -196,7 +196,7 @@ void initShortestPathBindings(py::module& m) {
return self.islandRadius(pt);
},
"pt"_a,
R"(Given a point, snaps to an islan and gets a heuristic of island size: the radius of a circle containing all NavMesh polygons within the specified island.)")
R"(Given a point, snaps to an island and gets a heuristic of island size: the radius of a circle containing all NavMesh polygons within the specified island.)")
.def(
"island_radius",
[](PathFinder& self, int islandIndex) {
Expand Down
4 changes: 2 additions & 2 deletions src/esp/bindings/SimBindings.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -56,13 +56,13 @@ void initSimConfigBindings(py::module& m) {
R"(Whether or not the agent can slide on NavMesh collisions.)")
.def_readwrite(
"create_renderer", &SimulatorConfiguration::createRenderer,
R"(Optimisation for non-visual simulation. If false, no renderer will be created and no materials or textures loaded.)")
R"(Optimization for non-visual simulation. If false, no renderer will be created and no materials or textures loaded.)")
.def_readwrite(
"leave_context_with_background_renderer",
&SimulatorConfiguration::leaveContextWithBackgroundRenderer,
R"(See tutorials/async_rendering.py)")
.def_readwrite("frustum_culling", &SimulatorConfiguration::frustumCulling,
R"(Enable or disable the frustum culling optimisation.)")
R"(Enable or disable the frustum culling optimization.)")
.def_readwrite(
"enable_physics", &SimulatorConfiguration::enablePhysics,
R"(Specifies whether or not dynamics is supported by the simulation if a suitable library (i.e. Bullet) has been installed. Install with --bullet to enable.)")
Expand Down
2 changes: 1 addition & 1 deletion src/esp/sim/SimulatorConfiguration.h
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ struct SimulatorConfiguration {
int gpuDeviceId = 0;
//! The Simulator and Pathfinder random seed. Set during scene initialization.
unsigned int randomSeed = 0;
//! Optimisation for non-visual simulation. If false, no renderer will be
//! Optimization for non-visual simulation. If false, no renderer will be
//! created and no materials or textures loaded.
bool createRenderer = true;
//! Whether or not the agent can slide on NavMesh collisions.
Expand Down
Loading