Merge pull request #117 from Exairnous/docs-typos

Fix typos, improve docs, and remove trailing periods.

README.md

@@ -69,7 +69,7 @@ You can override the Blender user scripts directory from the console to point to
 
 `BLENDER_USER_SCRIPTS=full_path_to_/hubs-blender-exporter blender`
 
-- ### Symlinking you addon to the Blender user scripts directory
+- ### Symlinking your addon to the Blender user scripts directory
 You can create a symbolic link pointing to `full_path_to_/hubs-blender-exporter/addons/io_hubs_addon` in your current Python scripts directory in Blender. This way you will also load any other addons that you have in that directory.
 
 **MacOS and Linux**

addons/io_hubs_addon/components/definitions/ammo_shape.py

@@ -19,46 +19,46 @@ class AmmoShape(HubsComponent):
         description="Type",
         items=[("box", "Box Collider", "A box-shaped primitive collision shape"),
                ("sphere", "Sphere Collider",
-                "A primitive collision shape which is represents a sphere"),
-               ("hull", "Convex Hull", "A convex hull wrapped around the objects vertices. A good analogy for a convex hull is an elastic membrane or balloon under pressure which is placed around a given set of vertices. When released the membrane will assume the shape of the convex hull."),
-               ("mesh", "Mesh Collider", "A shape made of the actual vertecies of the object. This can be expensive for large meshes.")],
+                "A primitive collision shape which represents a sphere"),
+               ("hull", "Convex Hull", "A convex hull wrapped around the object's vertices. A good analogy for a convex hull is an elastic membrane or balloon under pressure which is placed around a given set of vertices. When released the membrane will assume the shape of the convex hull"),
+               ("mesh", "Mesh Collider", "A shape made of the actual vertices of the object. This can be expensive for large meshes")],
         default="hull")
 
     # TODO Add conditional UI to show only the required properties per type
     fit: EnumProperty(
         name="Shape Fitting Mode",
         description="Shape fitting mode",
-        items=[("all", "Automatic fit all", "Automatically match the shape to fit the object's vertecies"),
-               ("manual", "Manual fit", "Use the manually specified dimensions to define the shape, ignoring the object's vertecies")],
+        items=[("all", "Automatic fit all", "Automatically match the shape to fit the object's vertices"),
+               ("manual", "Manual fit", "Use the manually specified dimensions to define the shape, ignoring the object's vertices")],
         default="all")
 
     halfExtents: FloatVectorProperty(
         name="Half Extents",
-        description="Half dimensions of the collider. (Only used when fit is set to \"manual\" and type is set ot \"box\").",
+        description="Half dimensions of the collider. (Only used when fit is set to \"manual\" and type is set to \"box\")",
         unit='LENGTH',
         subtype="XYZ",
         default=(0.5, 0.5, 0.5))
 
     minHalfExtent: FloatProperty(
         name="Min Half Extent",
-        description="The minimum size to use when automatically generating half extents. (Only used when fit is set to \"all\" and type is set ot \"box\")",
+        description="The minimum size to use when automatically generating half extents. (Only used when fit is set to \"all\" and type is set to \"box\")",
         unit="LENGTH",
         default=0.0)
 
     maxHalfExtent: FloatProperty(
         name="Max Half Extent",
-        description="The maximum size to use when automatically generating half extents. (Only used when fit is set to \"all\" and type is set ot \"box\")",
+        description="The maximum size to use when automatically generating half extents. (Only used when fit is set to \"all\" and type is set to \"box\")",
         unit="LENGTH",
         default=1000.0)
 
     sphereRadius: FloatProperty(
         name="Sphere Radius",
-        description="Radius of the sphere collider. (Only used when fit is set to \"manual\" and type is set ot \"sphere\")",
+        description="Radius of the sphere collider. (Only used when fit is set to \"manual\" and type is set to \"sphere\")",
         unit="LENGTH",
         default=0.5)
 
     offset: FloatVectorProperty(
-        name="Offset", description="An offset to apply to the collider relative to the object's origin.",
+        name="Offset", description="An offset to apply to the collider relative to the object's origin",
         unit='LENGTH',
         subtype="XYZ",
         default=(0.0, 0.0, 0.0))

addons/io_hubs_addon/components/definitions/audio.py

@@ -23,7 +23,7 @@ class Audio(HubsComponent):
                            default=True)
 
     controls: BoolProperty(name="Show controls",
-                           description="Show Controls",
+                           description="When enabled, shows play/pause, skip forward/back, and volume controls when hovering your cursor over it in Hubs",
                            default=True)
 
     loop: BoolProperty(name="Loop",

addons/io_hubs_addon/components/definitions/audio_params.py

@@ -41,29 +41,29 @@ class AudioParams(HubsComponent):
 
     refDistance: FloatProperty(
         name="Ref Distance",
-        description="A double value representing the reference distance for reducing volume as the audio source moves further from the listener. For distances greater than this the volume will be reduced based on rolloffFactor and distanceModel.",
+        description="A double value representing the reference distance for reducing volume as the audio source moves further from the listener. For distances greater than this the volume will be reduced based on rolloffFactor and distanceModel",
         subtype="DISTANCE",
         unit="LENGTH",
         default=1.0,
         min=0.0)
 
     rolloffFactor: FloatProperty(
         name="Rolloff Factor",
-        description="A double value describing how quickly the volume is reduced as the source moves away from the listener. This value is used by all distance models.",
+        description="A double value describing how quickly the volume is reduced as the source moves away from the listener. This value is used by all distance models",
         default=1.0,
         min=0.0)
 
     maxDistance: FloatProperty(
         name="Max Distance",
-        description="A double value representing the maximum distance between the audio source and the listener, after which the volume is not reduced any further. This value is used only by the linear distance model.",
+        description="A double value representing the maximum distance between the audio source and the listener, after which the volume is not reduced any further. This value is used only by the linear distance model",
         subtype="DISTANCE",
         unit="LENGTH",
         default=10000.0,
         min=0.0)
 
     coneInnerAngle: FloatProperty(
         name="Cone Inner Angle",
-        description="A double value describing the angle, in degrees, of a cone inside of which there will be no volume reduction.",
+        description="A double value describing the angle, in degrees, of a cone inside of which there will be no volume reduction",
         subtype="ANGLE",
         default=MAX_ANGLE,
         min=0.0,
@@ -72,7 +72,7 @@ class AudioParams(HubsComponent):
 
     coneOuterAngle: FloatProperty(
         name="Cone Outer Angle",
-        description="A double value describing the angle, in degrees, of a cone outside of which the volume will be reduced by a constant value, defined by the coneOuterGain attribute.",
+        description="A double value describing the angle, in degrees, of a cone outside of which the volume will be reduced by a constant value, defined by the coneOuterGain attribute",
         subtype="ANGLE",
         default=0.0,
         min=0.0,
@@ -81,7 +81,7 @@ class AudioParams(HubsComponent):
 
     coneOuterGain: FloatProperty(
         name="Cone Outer Gain",
-        description="A double value describing the amount of volume reduction outside the cone defined by the coneOuterAngle attribute.",
+        description="A double value describing the amount of volume reduction outside the cone defined by the coneOuterAngle attribute",
         default=0.0,
         min=0.0)
 

addons/io_hubs_addon/components/definitions/audio_source.py

@@ -14,10 +14,10 @@ class AudioSource(HubsComponent):
     }
 
     onlyMods: BoolProperty(
-        name="Only Mods", description="Only room moderators should be able to transmit audio from this source.", default=True)
+        name="Only Mods", description="Only room moderators are able to transmit audio from this source", default=True)
 
     muteSelf: BoolProperty(
-        name="Mute Self", description="Do not transmit your own audio to audio targets.", default=True)
+        name="Mute Self", description="Do not transmit your own audio to audio targets", default=True)
 
     debug: BoolProperty(
-        name="Debug", description="Play white noise when no audio source is in the zone.", default=False)
+        name="Debug", description="Play white noise when no audio source is in the zone", default=False)

addons/io_hubs_addon/components/definitions/audio_target.py

@@ -84,14 +84,14 @@ class AudioTarget(HubsComponent):
 
     srcNode: PointerProperty(
         name="Source",
-        description="Node with a audio-source-zone to pull audio from",
+        description="The object with an audio-source component to pull audio from",
         type=Object,
         poll=filter_on_component
     )
 
     bone: EnumProperty(
         name="Bone",
-        description="Bone",
+        description="The bone with an audio-source component to pull audio from.  If a bone is selected, this will override the object source, otherwise if no bone is selected, the source will be pulled from the object",
         items=get_bones,
         get=get_bone,
         set=set_bone
@@ -138,12 +138,12 @@ def draw(self, context, layout, panel):
             col = layout.column()
             col.alert = True
             col.label(
-                text=f'The selected source doesn\'t have a {AudioSource.get_display_name()} component', icon='ERROR')
+                text=f'The selected source doesn\'t have an {AudioSource.get_display_name()} component', icon='ERROR')
         elif self.srcNode and self.bone_id != BLANK_ID and not has_bone_component:
             col = layout.column()
             col.alert = True
             col.label(
-                text=f'The selected bone doesn\'t have a {AudioSource.get_display_name()} component', icon='ERROR')
+                text=f'The selected bone doesn\'t have an {AudioSource.get_display_name()} component', icon='ERROR')
 
         layout.prop(data=self, property="minDelay")
         layout.prop(data=self, property="maxDelay")

addons/io_hubs_addon/components/definitions/billboard.py

@@ -14,4 +14,4 @@ class Billboard(HubsComponent):
     }
 
     onlyY: BoolProperty(
-        name="Only Y", description="Rotate only in Y axis", default=False)
+        name="Only Y", description="Rotate only on the Y axis", default=False)

addons/io_hubs_addon/components/definitions/environment_settings.py

@@ -5,7 +5,7 @@
 from ..types import Category, PanelType, NodeType
 
 
-TOME_MAPPING = [("NoToneMapping", "None", "No tone mapping."),
+TOME_MAPPING = [("NoToneMapping", "None", "No tone mapping"),
                 ("LinearToneMapping", "Linear", "Linear tone mapping"),
                 ("ReinhardToneMapping", "ThreeJS 'Reinhard'",
                  "ThreeJS 'Reinhard' tone mapping"),

addons/io_hubs_addon/components/definitions/frustrum.py

@@ -6,12 +6,12 @@
 class Frustrum(HubsComponent):
     _definition = {
         'name': 'frustrum',
-        'display_name': 'Frustrum',
+        'display_name': 'Frustum',
         'category': Category.OBJECT,
         'node_type': NodeType.NODE,
         'panel_type': [PanelType.OBJECT],
         'icon': 'IMAGE_PLANE'
     }
 
     culled: BoolProperty(
-        name="Culled", description="Ignore entities outside of the camera frustrum. Frustrum culling can cause problems with some animations", default=True)
+        name="Culled", description="Ignore entities outside of the camera frustum. Frustum culling can cause problems with some animations", default=True)

addons/io_hubs_addon/components/definitions/image.py

@@ -17,9 +17,9 @@ class Image(HubsComponent):
     }
 
     src: StringProperty(
-        name="Image URL", description="Image URL", default="https://mozilla.org")
+        name="Image URL", description="The web address of the image", default="https://mozilla.org")
 
-    controls: BoolProperty(name="Controls", default=True)
+    controls: BoolProperty(name="Controls", description="When enabled, shows an \"open link\" button when hovering your cursor over it in Hubs that allows you to open the image in a new tab", default=True)
 
     alphaMode: EnumProperty(
         name="Transparency Mode",

addons/io_hubs_addon/components/definitions/loop_animation.py

@@ -574,7 +574,7 @@ class LoopAnimation(HubsComponent):
 
     timeScale: FloatProperty(
         name="Time Scale",
-        description="Scale animation playback speed by this factor. Normal playback rate being 1. Negative values will play the animation backwards.",
+        description="Scale animation playback speed by this factor. Normal playback rate being 1. Negative values will play the animation backwards",
         default=1.0
     )
 

addons/io_hubs_addon/components/definitions/media_frame.py

@@ -60,25 +60,25 @@ class MediaFrame(HubsComponent):
 
     bounds: FloatVectorProperty(
         name="Bounds",
-        description="Bounding box to fit objects into when they are snapped into the media frame.",
+        description="Bounding box to fit objects into when they are snapped into the media frame",
         unit='LENGTH',
         subtype="XYZ",
         default=(1.0, 1.0, 1.0))
 
     mediaType: EnumProperty(
         name="Media Type",
         description="Limit what type of media this frame will capture",
-        items=[("all", "All Media", "Allow any type of media."),
-               ("all-2d", "Only 2D Media", "Allow only Images, Videos, and PDFs."),
-               ("model", "Only 3D Models", "Allow only 3D models."),
-               ("image", "Only Images", "Allow only images."),
-               ("video", "Only Videos", "Allow only videos."),
-               ("pdf", "Only PDFs", "Allow only PDFs.")],
+        items=[("all", "All Media", "Allow any type of media"),
+               ("all-2d", "Only 2D Media", "Allow only Images, Videos, and PDFs"),
+               ("model", "Only 3D Models", "Allow only 3D models"),
+               ("image", "Only Images", "Allow only images"),
+               ("video", "Only Videos", "Allow only videos"),
+               ("pdf", "Only PDFs", "Allow only PDFs")],
         default="all-2d")
 
     snapToCenter: BoolProperty(
         name="Snap To Center",
-        description="Snap the media to the center of the media frame when capturing. If set to false the object will just remain in the place it was dorpped but still be considered \"captured\" by the media frame.",
+        description="Snap the media to the center of the media frame when capturing. If set to false the object will just remain in the place it was dropped but still be considered \"captured\" by the media frame",
         default=True
     )
 

addons/io_hubs_addon/components/definitions/particle_emitter.py

@@ -15,7 +15,7 @@ class ParticleEmitter(HubsComponent):
     }
 
     src: StringProperty(
-        name="Source", description="Source", default="https://mozilla.org")
+        name="Image Source", description="The web address (URL) of the image to use for each particle", default="https://mozilla.org")
 
     startColor: FloatVectorProperty(name="Start Color",
                                     description="Start Color",
@@ -75,7 +75,7 @@ class ParticleEmitter(HubsComponent):
         name="Age Randomness", description="Age Randomness", default=0.0)
 
     lifetime: FloatProperty(
-        name="Lifetime", description="Lifetime  ", unit="TIME", subtype="TIME", default=1.0)
+        name="Lifetime", description="Lifetime", unit="TIME", subtype="TIME", default=1.0)
 
     lifetimeRandomness: FloatProperty(
         name="Lifetime Randomness", description="Lifetime Randomness", default=0.0)

addons/io_hubs_addon/components/definitions/spawner.py

@@ -15,7 +15,7 @@ class Spawner(HubsComponent):
     }
 
     src: StringProperty(
-        name="URL", description="Source image URL", default="https://mozilla.org")
+        name="Model Source", description="The web address (URL) of the glTF to be spawned", default="https://mozilla.org")
 
     applyGravity: BoolProperty(
         name="Apply Gravity", description="Apply gravity to spawned object", default=False)

addons/io_hubs_addon/components/definitions/spot_light.py

@@ -36,15 +36,15 @@ class SpotLight(HubsComponent):
 
     innerConeAngle: FloatProperty(
         name="Cone Inner Angle",
-        description="A double value describing the angle, in degrees, of a cone inside of which there will be no volume reduction.",
+        description="A double value describing the angle, in degrees, of a cone inside of which there will be no volume reduction",
         subtype="ANGLE",
         default=0.0,
         min=0.0,
         max=pi / 2)
 
     outerConeAngle: FloatProperty(
         name="Cone Outer Angle",
-        description="A double value describing the angle, in degrees, of a cone outside of which the volume will be reduced by a constant value, defined by the coneOuterGain attribute.",
+        description="A double value describing the angle, in degrees, of a cone outside of which the volume will be reduced by a constant value, defined by the coneOuterGain attribute",
         subtype="ANGLE",
         default=pi / 4,
         min=0.0,