Przeglądaj źródła

Fixed spelling mistakes in source code comments.

Darryl Gough 13 lat temu
rodzic
commit
73ad70d735

+ 1 - 1
gameplay/src/AnimationClip.cpp

@@ -249,7 +249,7 @@ void AnimationClip::crossFade(AnimationClip* clip, unsigned long duration)
     _crossFadeToClip->setClipStateBit(CLIP_IS_FADING_IN_BIT);
     _crossFadeToClip->_blendWeight = 0.0f;
     
-    // Set and intiliaze this clip to fade out
+    // Set and initialize this clip to fade out
     setClipStateBit(CLIP_IS_FADING_OUT_STARTED_BIT);
     setClipStateBit(CLIP_IS_FADING_OUT_BIT);
     _crossFadeOutElapsed = 0.0f;

+ 1 - 1
gameplay/src/AnimationTarget.h

@@ -215,7 +215,7 @@ private:
      *
      * @param type The TargetType of the AnimationTarget.
      * @param propertyIdStr The property ID string.
-     * @return The property ID value for teh property ID string; -1 if the propertyIdStr does not exist
+     * @return The property ID value for the property ID string; -1 if the propertyIdStr does not exist
      *    for the TargetType.
      */
     static int getPropertyId(TargetType type, const char* propertyIdStr);

+ 1 - 1
gameplay/src/Bundle.h

@@ -285,7 +285,7 @@ private:
      * 
      * @param length A pointer to where the length of the array will be copied to.
      * @param values A pointer to the vector to copy the values to. The vector will be resized if it is smaller than length.
-     * @param readSize The size that reads will be preformed at, size must be the same as or smaller then the sizeof(T)
+     * @param readSize The size that reads will be performed at, size must be the same as or smaller then the sizeof(T)
      * 
      * @return True if successful, false if an error occurred.
      */

+ 1 - 1
gameplay/src/Button.h

@@ -27,7 +27,7 @@ namespace gameplay
          width       = <width>   // Can be used in place of 'size', e.g. with 'autoHeight = true'
          height      = <height>  // Can be used in place of 'size', e.g. with 'autoWidth = true'
          text        = <string>
-         consumeEvents = <bool>  // Whether the button propogates input events to the Game's input event handler. Defualt is true.
+         consumeEvents = <bool>  // Whether the button propagates input events to the Game's input event handler. Default is true.
     }
  @endverbatim
  */

+ 1 - 1
gameplay/src/CheckBox.h

@@ -28,7 +28,7 @@ namespace gameplay
          text        = <string>
          checked     = <bool>
          iconSize    = <width, height>   // The size to draw the checkbox icon, if different from its size in the texture.
-         consumeEvents = <bool>  // Whether the checkbox propogates input events to the Game's input event handler. Default is true.
+         consumeEvents = <bool>  // Whether the checkbox propagates input events to the Game's input event handler. Default is true.
     }
  @endverbatim
  */

+ 1 - 1
gameplay/src/Container.cpp

@@ -957,7 +957,7 @@ bool Container::mouseEventScroll(Mouse::MouseEvent evt, int x, int y, int wheelD
                 if (x + _viewportBounds.x >= vBounds.x &&
                     x + _viewportBounds.x <= vBounds.x + vBounds.width)
                 {
-                    // Then we're within the horizontal bounds of the verticle scrollbar.
+                    // Then we're within the horizontal bounds of the vertical scrollbar.
                     // We want to either jump up or down, or drag the scrollbar itself.
                     if (y < vBounds.y)
                     {

+ 1 - 1
gameplay/src/Container.h

@@ -27,7 +27,7 @@ namespace gameplay
          height      = <height>  // Can be used in place of 'size', e.g. with 'autoWidth = true'
          scroll      = <Container::Scroll constant> // Whether scrolling is allowed and in which directions.
          scrollBarsAutoHide = <bool>    // Whether scrollbars fade out when not in use.
-         consumeEvents = <bool>             // Whether the container propogates input events to the Game's input event handler. Default is true.
+         consumeEvents = <bool>             // Whether the container propagates input events to the Game's input event handler. Default is true.
 
          // All the nested controls within this container.
          container 

+ 2 - 2
gameplay/src/Effect.cpp

@@ -220,7 +220,7 @@ Effect* Effect::createFromSource(const char* vshPath, const char* vshSource, con
     GLint length;
     GLint success;
 
-    // Replace all comma seperated definitions with #define prefix and \n suffix
+    // Replace all comma separated definitions with #define prefix and \n suffix
     std::string definesStr = "";
     replaceDefines(defines, definesStr);
     
@@ -355,7 +355,7 @@ Effect* Effect::createFromSource(const char* vshPath, const char* vshSource, con
     // preferred attribute locations, we're going to query the locations that were
     // automatically bound by the GPU. While it can sometimes be convenient to use
     // glBindAttribLocation, some vendors actually reserve certain attribute indices
-    // and thereore using this function can create compatibility issues between
+    // and therefore using this function can create compatibility issues between
     // different hardware vendors.
     GLint activeAttributes;
     GL_ASSERT( glGetProgramiv(program, GL_ACTIVE_ATTRIBUTES, &activeAttributes) );

+ 1 - 1
gameplay/src/FileSystem.h

@@ -39,7 +39,7 @@ public:
      * Loads a properties file containing a list of filesystem aliases.
      *
      * The specified aliases file is a valid properties file that contains one
-     * or more namespaces with a list of fielsystem aliases that will be used
+     * or more namespaces with a list of filesystem aliases that will be used
      * to establish soft links to files when reading files through this class.
      *
      * This can be helpful for managing loading of resources that may change

+ 1 - 1
gameplay/src/Form.cpp

@@ -538,7 +538,7 @@ void Form::draw()
     // to texture a quad.  The quad will be given the same dimensions as the form and
     // must be transformed appropriately by the user, unless they call setQuad() themselves.
     // On the other hand, if this form has not been set on a node, SpriteBatch will be used
-    // to render the contents of the frambuffer directly to the display.
+    // to render the contents of the framebuffer directly to the display.
 
     // Check whether this form has changed since the last call to draw() and if so, render into the framebuffer.
     if (isDirty())

+ 1 - 1
gameplay/src/Form.h

@@ -32,7 +32,7 @@ class Theme;
         size       = <width, height>       // Size of the form, measured in pixels.
         width      = <width>               // Can be used in place of 'size', e.g. with 'autoHeight = true'
         height     = <height>              // Can be used in place of 'size', e.g. with 'autoWidth = true'
-        consumeEvents = <bool>             // Whether the form propogates input events to the Game's input event handler. Default is false
+        consumeEvents = <bool>             // Whether the form propagates input events to the Game's input event handler. Default is false
       
         // All the nested controls within this form.
         container { }

+ 1 - 1
gameplay/src/Gamepad.h

@@ -111,7 +111,7 @@ public:
      *
      * Note: What if the user decides to add gamepad controls (joysticks, buttons) to the gamepad form? How do we handle new/deleted controls?
      *
-     * @return the Form used to represent this gamepad. NULL if the gamepad is not reprented with a Form.
+     * @return the Form used to represent this gamepad. NULL if the gamepad is not represented with a Form.
      */
     Form* getForm() const;
 

+ 1 - 1
gameplay/src/Joystick.h

@@ -17,7 +17,7 @@ namespace gameplay
         alignment   = <Control::Alignment constant> // Note: 'position' will be ignored.
         size        = <width, height>           // Size of the Control, measured in pixels.
         radius      = <float>                   // The value of the left- / bottom-most point on the slider.
-        consumeEvents = <bool>                  // Whether the slider propogates input events to the Game's input event handler. Default is true.
+        consumeEvents = <bool>                  // Whether the slider propagates input events to the Game's input event handler. Default is true.
         
     }
  @endverbatim

+ 1 - 1
gameplay/src/Label.h

@@ -24,7 +24,7 @@ namespace gameplay
          width       = <width>   // Can be used in place of 'size', e.g. with 'autoHeight = true'
          height      = <height>  // Can be used in place of 'size', e.g. with 'autoWidth = true'
          text        = <string>
-         consumeEvents = <bool>  // Whether the label propogates input events to the Game's input event handler. Default is true.
+         consumeEvents = <bool>  // Whether the label propagates input events to the Game's input event handler. Default is true.
     }
  @endverbatim
  */

+ 1 - 1
gameplay/src/Logger.cpp

@@ -29,7 +29,7 @@ void Logger::log(Level level, const char* message, ...)
     va_start(args, message);
 
     // Declare a moderately sized buffer on the stack that should be
-    // large enough to accomodate most log requests.
+    // large enough to accommodate most log requests.
     int size = 1024;
     char stackBuffer[1024];
     std::vector<char> dynamicBuffer;

+ 1 - 1
gameplay/src/Matrix.h

@@ -129,7 +129,7 @@ public:
      * Creates a view matrix based on the specified input parameters.
      *
      * @param eyePosition The eye position.
-     * @param targetPosition The target's cener position.
+     * @param targetPosition The target's center position.
      * @param up The up vector.
      * @param dst A matrix to store the result in.
      */

+ 1 - 1
gameplay/src/Node.cpp

@@ -839,7 +839,7 @@ const BoundingSphere& Node::getBoundingSphere() const
                 // world matrix. This computes a final world matrix used for transforming this
                 // node's bounding volume. This allows us to store a much smaller bounding
                 // volume approximation than would otherwise be possible for skinned meshes,
-                // since joint parent nodes that are not in the matrix pallette do not need to
+                // since joint parent nodes that are not in the matrix palette do not need to
                 // be considered as directly transforming vertices on the GPU (they can instead
                 // be applied directly to the bounding volume transformation below).
                 GP_ASSERT(_model->getSkin()->getRootJoint());

+ 1 - 1
gameplay/src/Node.h

@@ -539,7 +539,7 @@ public:
     /**
      * Sets the physics collision object for this node from the given properties object.
      * 
-     * @param properties The properties object defining the collision ojbect.
+     * @param properties The properties object defining the collision object.
      */
     PhysicsCollisionObject* setCollisionObject(Properties* properties);
 

+ 3 - 3
gameplay/src/PhysicsCharacter.cpp

@@ -309,7 +309,7 @@ void PhysicsCharacter::stepUp(btCollisionWorld* collisionWorld, btScalar time)
 
     if (_verticalVelocity.isZero())
     {
-        // Simply increase our poisiton by step height to enable us
+        // Simply increase our position by step height to enable us
         // to smoothly move over steps.
         targetPosition += btVector3(0, _stepHeight, 0);
     }
@@ -521,7 +521,7 @@ static btVector3 parallelComponent(const btVector3& direction, const btVector3&
 }
 
 /*
- * Returns the portion of 'direction' that is perpindicular to 'normal'.
+ * Returns the portion of 'direction' that is perpendicular to 'normal'.
  */
 static btVector3 perpindicularComponent(const btVector3& direction, const btVector3& normal)
 {
@@ -572,7 +572,7 @@ bool PhysicsCharacter::fixCollision(btCollisionWorld* world)
     _node->getWorldMatrix().getTranslation(&startPosition);
     btVector3 currentPosition = BV(startPosition);
 
-    // Handle all collisions/overlappign pairs.
+    // Handle all collisions/overlapping pairs.
     btScalar maxPenetration = btScalar(0.0);
     for (int i = 0, count = pairCache->getNumOverlappingPairs(); i < count; ++i)
     {

+ 1 - 1
gameplay/src/PhysicsCollisionObject.h

@@ -251,7 +251,7 @@ protected:
         ScriptListener(const char* url);
 
         /**
-         * @see PhysicsColliionObject::CollisionListener
+         * @see PhysicsCollisionObject::CollisionListener
          */
         void collisionEvent(PhysicsCollisionObject::CollisionListener::EventType type, const PhysicsCollisionObject::CollisionPair& collisionPair,
                                     const Vector3& contactPointA, const Vector3& contactPointB);

+ 1 - 1
gameplay/src/PhysicsController.cpp

@@ -1027,7 +1027,7 @@ PhysicsCollisionShape* PhysicsController::createHeightfield(Node* node, Image* i
         for (unsigned int y = 0, h = image->getHeight(); y < h; ++y)
         {
             //
-            // Orignially in GamePlay this was normalizedHeightGrayscale which generally yielded
+            // Originally in GamePlay this was normalizedHeightGrayscale which generally yielded
             // only 8-bit precision. This has been replaced by normalizedHeightPacked (with a
             // corresponding change in gameplay-encoder).
             //

+ 2 - 2
gameplay/src/PlatformBlackBerry.cpp

@@ -636,7 +636,7 @@ Platform* Platform::create(Game* game, void* attachToWindow)
         goto error;
     }
 
-    // Set/get any window prooperties.
+    // Set/get any window properties.
     rc = screen_set_window_property_iv(__screenWindow, SCREEN_PROPERTY_FORMAT, &screenFormat);
     if (rc)
     {
@@ -1316,7 +1316,7 @@ bool Platform::mouseEventInternal(Mouse::MouseEvent evt, int x, int y, int wheel
 
 bool Platform::isGestureSupported(Gesture::GestureEvent evt)
 {
-    // All are supported no need to test th bitset
+    // All are supported no need to test the bitset
     return true;
 }
 

+ 1 - 1
gameplay/src/Quaternion.cpp

@@ -389,7 +389,7 @@ void Quaternion::slerpForSquad(const Quaternion& q1, const Quaternion& q2, float
     // cos(omega) = q1 * q2;
     // slerp(q1, q2, t) = (q1*sin((1-t)*omega) + q2*sin(t*omega))/sin(omega);
     // q1 = +- q2, slerp(q1,q2,t) = q1.
-    // This is a straight-foward implementation of the formula of slerp. It does not do any sign switching.
+    // This is a straight-forward implementation of the formula of slerp. It does not do any sign switching.
     float c = q1.x * q2.x + q1.y * q2.y + q1.z * q2.z + q1.w * q2.w;
 
     if (fabs(c) >= 1.0f)

+ 1 - 1
gameplay/src/RadioButton.h

@@ -30,7 +30,7 @@ namespace gameplay
          text        = <string>
          group       = <string>
          iconSize    = <width, height>   // The size to draw the radio button icon, if different from its size in the texture.
-         consumeEvents = <bool>          // Whether the radio button propogates input events to the Game's input event handler. Default is true.
+         consumeEvents = <bool>          // Whether the radio button propagates input events to the Game's input event handler. Default is true.
     }
  @endverbatim
  */

+ 1 - 1
gameplay/src/RenderState.cpp

@@ -485,7 +485,7 @@ void RenderState::StateBlock::enableDepthWrite()
     GP_ASSERT(_defaultState);
 
     // Internal method used by Game::clear() to restore depth writing before a
-    // clear operation. This is neccessary if the last code to draw before the
+    // clear operation. This is necessary if the last code to draw before the
     // next frame leaves depth writing disabled.
     if (!_defaultState->_depthWriteEnabled)
     {

+ 1 - 1
gameplay/src/ScriptController.h

@@ -81,7 +81,7 @@ public:
     operator T* () const;
 
     /**
-     * Overloades [] operator to get/set item value at index.
+     * Overloads [] operator to get/set item value at index.
      */
     T& operator[] (int index);
 

+ 1 - 1
gameplay/src/Slider.h

@@ -25,7 +25,7 @@ namespace gameplay
         value       = <float>                   // The default position of the marker.
         step        = <float>                   // If greater than 0, force the marker to snap to discrete multiples of 'step'.
         text        = <string>                  // Text to display above, below or alongside the slider (depending on the style).
-        consumeEvents = <bool>                  // Whether the slider propogates input events to the Game's input event handler. Default is true.
+        consumeEvents = <bool>                  // Whether the slider propagates input events to the Game's input event handler. Default is true.
         // TODO: orientation = <HORIZONTAL or VERTICAL>  // Determines whether a slider is stretched along its width or its height
     }
  @endverbatim