Collision.hh

Go to the documentation of this file.

/*
 * Copyright (C) 2012 Open Source Robotics Foundation
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
*/
#ifndef GAZEBO_PHYSICS_COLLISION_HH_
#define GAZEBO_PHYSICS_COLLISION_HH_

#include <string>
#include <vector>

#include "gazebo/common/Event.hh"

#include "gazebo/physics/PhysicsTypes.hh"
#include "gazebo/physics/CollisionState.hh"
#include "gazebo/physics/Entity.hh"
#include "gazebo/util/system.hh"

namespace gazebo
{
  namespace physics
  {

    class GZ_PHYSICS_VISIBLE Collision : public Entity
    {
      public: explicit Collision(LinkPtr _link);

      public: virtual ~Collision();

      public: virtual void Fini();

      public: virtual void Load(sdf::ElementPtr _sdf);

      public: virtual void Init();

      public: virtual void UpdateParameters(sdf::ElementPtr _sdf);

      public: void SetCollision(bool _placeable);

      public: void SetPlaceable(const bool _placeable);

      public: bool IsPlaceable() const;

      public: virtual void SetCategoryBits(unsigned int _bits) = 0;

      public: virtual void SetCollideBits(unsigned int _bits) = 0;

      public: void SetLaserRetro(float _retro);

      public: float GetLaserRetro() const;

      public: LinkPtr GetLink() const;

      public: ModelPtr GetModel() const;

      public: virtual ignition::math::Box BoundingBox() const = 0;

      public: unsigned int GetShapeType() const;

      public: void SetShape(ShapePtr _shape);

      public: ShapePtr GetShape() const;

      public: void SetScale(const math::Vector3 &_scale) GAZEBO_DEPRECATED(8.0);

      public: void SetScale(const ignition::math::Vector3d &_scale);

      public: virtual math::Vector3 GetRelativeLinearVel() const
              GAZEBO_DEPRECATED(8.0);

      public: virtual ignition::math::Vector3d RelativeLinearVel() const;

      public: virtual math::Vector3 GetWorldLinearVel() const
              GAZEBO_DEPRECATED(8.0);

      public: virtual ignition::math::Vector3d WorldLinearVel() const;

      public: virtual math::Vector3 GetRelativeAngularVel() const
              GAZEBO_DEPRECATED(8.0);

      public: virtual ignition::math::Vector3d RelativeAngularVel() const;

      public: virtual math::Vector3 GetWorldAngularVel() const
              GAZEBO_DEPRECATED(8.0);

      public: virtual ignition::math::Vector3d WorldAngularVel() const;

      public: virtual math::Vector3 GetRelativeLinearAccel() const
              GAZEBO_DEPRECATED(8.0);

      public: virtual ignition::math::Vector3d RelativeLinearAccel() const;

      public: virtual math::Vector3 GetWorldLinearAccel() const
              GAZEBO_DEPRECATED(8.0);

      public: virtual ignition::math::Vector3d WorldLinearAccel() const;

      public: virtual math::Vector3 GetRelativeAngularAccel() const
              GAZEBO_DEPRECATED(8.0);

      public: virtual ignition::math::Vector3d RelativeAngularAccel() const;

      public: virtual math::Vector3 GetWorldAngularAccel() const
              GAZEBO_DEPRECATED(8.0);

      public: virtual ignition::math::Vector3d WorldAngularAccel() const;

      public: CollisionState GetState();

      public: void SetState(const CollisionState &_state);

      public: void FillMsg(msgs::Collision &_msg);

      public: void ProcessMsg(const msgs::Collision &_msg);

      public: inline SurfaceParamsPtr GetSurface() const
              {return this->surface;}

      public: virtual void SetMaxContacts(unsigned int _maxContacts);

      public: virtual unsigned int GetMaxContacts();

      public: void SetWorldPoseDirty();

      // Documentation inherited.
      public: virtual const math::Pose GetWorldPose() const
              GAZEBO_DEPRECATED(8.0);

      // Documentation inherited.
      public: virtual const ignition::math::Pose3d &WorldPose() const;

      private: msgs::Visual CreateCollisionVisual();

      protected: LinkPtr link;

      protected: bool placeable;

      protected: ShapePtr shape;

      protected: SurfaceParamsPtr surface;

      private: float laserRetro;

      private: CollisionState state;

      private: unsigned int maxContacts;

      private: uint32_t collisionVisualId;

      private: mutable bool worldPoseDirty;
    };
  }
}
#endif