// Filename: linearControlForce.h
// Created by: Dave Schuyler (2006)
//
////////////////////////////////////////////////////////////////////
//
// PANDA 3D SOFTWARE
// Copyright (c) 2001 - 2004, Disney Enterprises, Inc.  All rights reserved
//
// All use of this software is subject to the terms of the Panda 3d
// Software license.  You should have received a copy of this license
// along with this source code; you will also find a current copy of
// the license at http://etc.cmu.edu/panda3d/docs/license/ .
//
// To contact the maintainers of this program write to
// panda3d-general@lists.sourceforge.net .
//
////////////////////////////////////////////////////////////////////

#ifndef LINEARCONTROLFORCE_H
#define LINEARCONTROLFORCE_H

#include "linearForce.h"

////////////////////////////////////////////////////////////////
//       Class : LinearControlForce
// Description : Simple directed vector force.  This force is 
//               different from the others in that it can be
//               global and still only affect a single object.
//               That might not make sense for a physics simulation,
//               but it's very handy for a game.  I.e. this is
//               the force applied by user on the selected object.
////////////////////////////////////////////////////////////////
class EXPCL_PANDAPHYSICS LinearControlForce : public LinearForce {
PUBLISHED:
  LinearControlForce(const PhysicsObject *po = 0, float a = 1.0f,
    bool mass = false);
  LinearControlForce(const LinearControlForce &copy);
  virtual ~LinearControlForce();

  INLINE void clear_physics_object();
  INLINE void set_physics_object(const PhysicsObject *po);
  INLINE CPT(PhysicsObject) get_physics_object() const;

  INLINE void set_vector(const LVector3f& v);
  INLINE void set_vector(float x, float y, float z);

  INLINE LVector3f get_local_vector() const;
  
  virtual void output(ostream &out) const;
  virtual void write(ostream &out, unsigned int indent=0) const;

private:
  CPT(PhysicsObject) _physics_object;
  LVector3f _fvec;

  virtual LinearForce *make_copy();
  virtual LVector3f get_child_vector(const PhysicsObject *po);

public:
  static TypeHandle get_class_type() {
    return _type_handle;
  }
  static void init_type() {
    LinearForce::init_type();
    register_type(_type_handle, "LinearControlForce",
                  LinearForce::get_class_type());
  }
  virtual TypeHandle get_type() const {
    return get_class_type();
  }
  virtual TypeHandle force_init_type() {init_type(); return get_class_type();}

private:
  static TypeHandle _type_handle;
};

#include "linearControlForce.I"

#endif // LINEARCONTROLFORCE_H
