panda3d/dtool/src/interrogate/parameterRemap.I

// Filename: parameterRemap.I
// Created by:  drose (01Aug00)
//
////////////////////////////////////////////////////////////////////
//
// 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
// [email protected] .
//
////////////////////////////////////////////////////////////////////


////////////////////////////////////////////////////////////////////
//     Function: ParameterRemap::Constructor
//       Access: Public
//  Description:
////////////////////////////////////////////////////////////////////
INLINE ParameterRemap::
ParameterRemap(CPPType *orig_type) :
  _orig_type(orig_type),
  _new_type(orig_type)
{
  _is_valid = true;
  _temporary_type = (CPPType *)NULL;
  _default_value = (CPPExpression *)NULL;
}

////////////////////////////////////////////////////////////////////
//     Function: ParameterRemap::is_valid
//       Access: Public
//  Description:
////////////////////////////////////////////////////////////////////
INLINE bool ParameterRemap::
is_valid() const {
  return _is_valid;
}

////////////////////////////////////////////////////////////////////
//     Function: ParameterRemap::get_orig_type
//       Access: Public
//  Description: Returns the type of the original, C++ parameter or
//               return value.
////////////////////////////////////////////////////////////////////
INLINE CPPType *ParameterRemap::
get_orig_type() const {
  return _orig_type;
}

////////////////////////////////////////////////////////////////////
//     Function: ParameterRemap::get_new_type
//       Access: Public
//  Description: Returns the type of the wrapper's parameter or return
//               value.  This is the type that will be reported in the
//               interrogate database, and the type that the scripting
//               language is expected to deal with.
////////////////////////////////////////////////////////////////////
INLINE CPPType *ParameterRemap::
get_new_type() const {
  return _new_type;
}

////////////////////////////////////////////////////////////////////
//     Function: ParameterRemap::get_temporary_type
//       Access: Public
//  Description: Returns the type of any temporary variables used to
//               hold the return value before returning it.  This is
//               normally the same as get_new_type(), but in some
//               circumstances it may need to be different.
////////////////////////////////////////////////////////////////////
INLINE CPPType *ParameterRemap::
get_temporary_type() const {
  if (_temporary_type == (CPPType *)NULL) {
    return _new_type;
  } else {
    return _temporary_type;
  }
}

////////////////////////////////////////////////////////////////////
//     Function: ParameterRemap::has_default_value
//       Access: Public
//  Description: Returns true if this particular parameter has a
//               default value defined.
////////////////////////////////////////////////////////////////////
INLINE bool ParameterRemap::
has_default_value() const {
  return (_default_value != (CPPExpression *)NULL);
}

////////////////////////////////////////////////////////////////////
//     Function: ParameterRemap::get_default_value
//       Access: Public
//  Description: Returns the expression corresponding to this parameter's
//               default value.
////////////////////////////////////////////////////////////////////
INLINE CPPExpression *ParameterRemap::
get_default_value() const {
  return _default_value;
}

////////////////////////////////////////////////////////////////////
//     Function: ParameterRemap::set_default_value
//       Access: Public
//  Description: Records a default value to be associated with this
//               parameter.
////////////////////////////////////////////////////////////////////
INLINE void ParameterRemap::
set_default_value(CPPExpression *expr) {
  _default_value = expr;
}