DataControlPluginScripting.cc

/*===========================================================================*\
*                                                                            *
*                              OpenFlipper                                   *
 *           Copyright (c) 2001-2015, RWTH-Aachen University                 *
 *           Department of Computer Graphics and Multimedia                  *
 *                          All rights reserved.                             *
 *                            www.openflipper.org                            *
 *                                                                           *
 *---------------------------------------------------------------------------*
 * This file is part of OpenFlipper.                                         *
 *---------------------------------------------------------------------------*
 *                                                                           *
 * Redistribution and use in source and binary forms, with or without        *
 * modification, are permitted provided that the following conditions        *
 * are met:                                                                  *
 *                                                                           *
 * 1. Redistributions of source code must retain the above copyright notice, *
 *    this list of conditions and the following disclaimer.                  *
 *                                                                           *
 * 2. Redistributions in binary form must reproduce the above copyright      *
 *    notice, this list of conditions and the following disclaimer in the    *
 *    documentation and/or other materials provided with the distribution.   *
 *                                                                           *
 * 3. Neither the name of the copyright holder nor the names of its          *
 *    contributors may be used to endorse or promote products derived from   *
 *    this software without specific prior written permission.               *
 *                                                                           *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS       *
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED *
 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A           *
 * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER *
 * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,  *
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,       *
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR        *
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF    *
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING      *
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS        *
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.              *
*                                                                            *
\*===========================================================================*/






#include "DataControlPlugin.hh"


//******************************************************************************

void DataControlPlugin::setDescriptions(){

  emit setSlotDescription("getSourceObjects(DataType)",tr("Returns the IdList of all source objects with given DataType."),
                          QStringList(tr("Datatype")), QStringList(tr("Datatype of the objects")));

  emit setSlotDescription("getTargetObjects(DataType)",tr("Returns the IdList of all target objects with given DataType."),
                          QStringList(tr("Datatype")), QStringList(tr("Datatype of the objects")));

  emit setSlotDescription("getObject(QString)",tr("Returns the id of an object with given name."),
                          QStringList(tr("Name")), QStringList(tr("Name of an object")));

  emit setSlotDescription("getObjectName(int)",tr("Returns the name of an object with given id."),
                          QStringList(tr("objectId")), QStringList(tr("ID of an object")));

  emit setSlotDescription("dataType(int)",tr("Returns the DataType of the object with the given id."),
                          QStringList(tr("objectId")), QStringList(tr("ID of an object")));

  emit setSlotDescription("hideObject(int)",tr("Hide object with the given id."),
                          QStringList(tr("objectId")), QStringList(tr("ID of an object")));

  emit setSlotDescription("showObject(int)",tr("Show object with the given id."),
                          QStringList(tr("objectId")), QStringList(tr("ID of an object")));

  emit setSlotDescription("setTarget(int,bool)",tr("Set given object as target."),
                          QString(tr("ObjectId,Target")).split(","),
                          QString(tr("id of the object, set object as target?")).split(","));

  emit setSlotDescription("setSource(int,bool)",tr("Set given object as source."),
                          QString(tr("ObjectId,Source")).split(","),
                          QString(tr("id of the object, set object as source?")).split(","));

  emit setSlotDescription("setObjectName(int,QString)",tr("Set name of given object."),
                          QString(tr("ObjectId,name")).split(","),
                          QString(tr("id of the object, the new name")).split(","));

  emit setSlotDescription("addEmptyGroup(QString)", tr("Create new empty group."),
                          QStringList(tr("GroupName")),
                          QStringList(tr("Name of the new group.")));

  emit setSlotDescription("addEmptyGroup(QString,int)", tr("Create new empty group."),
                          QString(tr("GroupName,Parent")).split(","),
                          QString(tr("Name of the new group., Parent of the new group, or -1, if there is no parent.")).split(","));

  emit setSlotDescription("groupObjects(IdList,QString)",tr("Group given Objects together."),
                          QString(tr("objectIds,groupName")).split(","),
                          QString(tr("List of objects that should be grouped., Name of the group.")).split(","));

  emit setSlotDescription("groupObjects(IdList)",tr("Group given Objects together."),
                          QStringList(tr("objectIds")), QStringList(tr("List of objects that should be grouped.")));

  emit setSlotDescription("groupCount()",tr("Returns the number of group objects."),
                          QStringList(tr("")), QStringList(tr("")));
                          
  emit setSlotDescription("unGroupObject(int)",tr("Remove the given object from its group and append to root node."),
                          QStringList(tr("ObjectId")), QStringList(tr("Object to be removed from group.")));                          

  emit setSlotDescription("objectDelete(int)",tr("Delete an object"),
                          QStringList(tr("objectId")), QStringList(tr("Delete the given object.")));

  emit setSlotDescription("getGroupElements(int)",tr("Get elements of a group"),
                          QStringList(tr("groupId")), QStringList(tr("Id of the group.")));

  emit setSlotDescription("copyObject(int)",tr("Create a copy of an object"),
                          QStringList(tr("objectId")), QStringList(tr("Object to copy.")));

  emit setSlotDescription("setAllTarget()",tr("Set All objects as targets"),
                          QStringList(), QStringList());

  emit setSlotDescription("setAllSource()",tr("Set All objects as source"),
                          QStringList(), QStringList());

  emit setSlotDescription("clearAllTarget()",tr("Clear targets"),
                          QStringList(), QStringList());

  emit setSlotDescription("clearAllSource()",tr("Clear sources"),
                          QStringList(), QStringList());

  emit setSlotDescription("showAll()",tr("Show all objects"),
                          QStringList(), QStringList());

  emit setSlotDescription("hideAll()",tr("Hide all objects"),
                          QStringList(), QStringList());

  emit setSlotDescription("availableDataTypeNames()",tr("Returns a QStringList of all available DataType names."),
                          QStringList(tr("")), QStringList(tr("")));

  emit setSlotDescription("printObjectInfoToLog()",tr("Print info about all objects to log"),
                          QStringList(), QStringList());

  emit setSlotDescription("addObjectToGroup(int,int)",tr("Add an Object to an existing group"),
                          QStringList(tr("objectId,groupId").split(",")),
                          QStringList(tr("ID of an object.,ID of an group where the object has to be added.").split(",")));

}


//******************************************************************************

int DataControlPlugin::getObject( QString _name ) {

  BaseObject* object = PluginFunctions::objectRoot()->childExists(_name);

  if ( object == 0)
    return -1;

  return object->id();
}


//******************************************************************************

int DataControlPlugin::copyObject( int objectId ) {

  int newObject;

  emit copyObject( objectId, newObject );

  return newObject;
}


//******************************************************************************

QString DataControlPlugin::getObjectName( int objectId ) {

  BaseObjectData* object;
  if ( ! PluginFunctions::getObject(objectId,object) ) {
    emit log(LOGERR,tr("getObjectName : unable to get object") );
    return QString(tr("Unknown Object"));
  } else
    return  object->name() ;

}

//******************************************************************************

DataType DataControlPlugin::dataType( int _objectId ) {
  BaseObject* object = 0;
  PluginFunctions::getObject(_objectId,object);

  if ( object )
    return object->dataType();
  else
    return DATA_UNKNOWN;
}


//******************************************************************************

void DataControlPlugin::hideObject( int objectId ) {

  if ( ! OpenFlipper::Options::gui())
    return;

  BaseObjectData* object;
  if ( PluginFunctions::getObject(objectId,object) ){
    object->hide();
  }

}


//******************************************************************************

void DataControlPlugin::setTarget( int objectId, bool _target ) {

  BaseObjectData* object;
  if ( PluginFunctions::getObject(objectId,object) ){
    object->target( _target );
  }
}


//******************************************************************************

void DataControlPlugin::setSource( int objectId, bool _source ) {

  BaseObjectData* object;
  if ( PluginFunctions::getObject(objectId,object) ){
    object->source( _source );
  }

}


//******************************************************************************

void DataControlPlugin::setObjectName( int objectId, QString _name ) {

  BaseObjectData* object;
  if ( PluginFunctions::getObject(objectId,object) ){
    object->setName( _name );
  }
}


//******************************************************************************

void DataControlPlugin::objectDelete( int objectId ) {

  BaseObjectData* object;
  if ( ! PluginFunctions::getObject(objectId,object) )
    return;

  if ( object == 0)
    return;

  emit deleteObject(objectId);
}


//******************************************************************************

void DataControlPlugin::showObject( int objectId ) {

  if ( ! OpenFlipper::Options::gui())
      return;

  BaseObjectData* object;
  if ( PluginFunctions::getObject(objectId,object) ){
    object->show();
  }

}


//******************************************************************************

int DataControlPlugin::addEmptyGroup(QString _groupName, int _parentGroupId) {
        GroupObject* parentGroupObject = dynamic_cast<GroupObject*>(PluginFunctions::objectRoot());
        BaseObject* parentObject = 0;
        if (PluginFunctions::getObject(_parentGroupId, parentObject)) {
                GroupObject* parent = dynamic_cast<GroupObject*>(parentObject);
                if (parent) {
                        parentGroupObject = parent;
                } else {
                        emit log(LOGWARN, tr("Parent object %1 is not a group, creating a new toplevel group").arg(_parentGroupId));
                }
        } else if (_parentGroupId != 0 ) {
                emit log(LOGWARN, tr("Cannot get parent object %1, creating a new toplevel group").arg(_parentGroupId));
        }

        GroupObject* groupObject = new GroupObject("newGroup", parentGroupObject);

        if (_groupName == "") {
                groupObject->setName(tr("New group ") + QString::number(groupObject->id()));
        } else {
                groupObject->setName(_groupName);
        }

        emit emptyObjectAdded(groupObject->id());

        return groupObject->id();
}

//******************************************************************************

int DataControlPlugin::groupObjects(IdList _objectIDs, QString _groupName) {
  QVector< BaseObject* > objs;

  // Try to get all objects given in list
  for (uint i=0; i < _objectIDs.size(); i++){
    BaseObject* obj;
    if ( PluginFunctions::getObject(_objectIDs[i],obj) )
      objs.push_back(obj);
  }

  // If all of them fail, stop here.
  if (objs.size() == 0){
    emit log(tr("No objects to group."));
    return -1;
  }

  // Check if all objects have the same parent
  // Abort if the parents differ
  BaseObject* parent = (objs[0])->parent();
  for ( int i = 1 ; i < objs.size() ; ++i){
    if ( parent != (objs[i])->parent() ){
      emit log(tr("Cannot group Objects with different parents"));
      return -1;
    }

  }

  //create new group
  int groupId = addEmptyGroup(_groupName);
  BaseObject *groupItem = 0;
  PluginFunctions::getObject(groupId, groupItem);

  if (parent) {
    groupItem->setParent(parent);
  }

  IdList ids;
  //append new children to group
  for ( int i = 0 ; i < objs.size() ; ++i)
  {
    (objs[i])->setParent(groupItem);
    ids.push_back((objs[i])->id());
  }

  emit objectsGrouped(ids);
  emit updatedObject(groupId,UPDATE_ALL);
  
  return groupId;
}

//******************************************************************************

bool DataControlPlugin::unGroupObject(int _id) {
  BaseObject* group = 0;
  
  PluginFunctions::getObject(_id,group);
 
  if ( group && group->isGroup())
  {
    //iterate over children
    for (int i=group->childCount()-1; i >= 0; --i){
      BaseObject* child = group->child(i);

      // then change the parent
      child->setParent(group->parent());
    }
    //delete the group
    emit deleteObject( group->id() );

    return true;
  } else {
    if (group)
      emit log( LOGERR, tr("Cannot Ungroup. Object with id %1 is not a group").arg(_id));
    else
      emit log( LOGERR, tr( "Unable to get Object with id %1 for ungrouping").arg(_id) );
    return false;
  }
}


//******************************************************************************

void DataControlPlugin::setAllTarget() {

  DataType type = DATA_ALL;

  //try to find dataType restriction if called by contextMenu
  QAction* action = dynamic_cast< QAction* > ( sender() );

  if ( action != 0 && action->data().isValid() )
    type = (DataType) action->data().toUInt();

  for (auto* o_it : PluginFunctions::objects(PluginFunctions::ALL_OBJECTS, type) ) {
    o_it->target(true);
  }
}


//******************************************************************************

void DataControlPlugin::setAllSource() {

  DataType type = DATA_ALL;

  //try to find dataType restriction if called by contextMenu
  QAction* action = dynamic_cast< QAction* > ( sender() );

  if ( action != 0 && action->data().isValid() )
    type = (DataType) action->data().toUInt();

  for (auto* o_it : PluginFunctions::objects(PluginFunctions::ALL_OBJECTS, type) ) {
    o_it->source(true);
  }
}


//******************************************************************************

void DataControlPlugin::clearAllTarget() {

  DataType type = DATA_ALL;

  //try to find dataType restriction if called by contextMenu
  QAction* action = dynamic_cast< QAction* > ( sender() );

  if ( action != 0 && action->data().isValid() )
    type = (DataType) action->data().toUInt();

  for (auto* o_it : PluginFunctions::objects(PluginFunctions::ALL_OBJECTS, type) ) {
    o_it->target(false);
  }
}


//******************************************************************************

void DataControlPlugin::clearAllSource() {

  DataType type = DATA_ALL;

  //try to find dataType restriction if called by contextMenu
  QAction* action = dynamic_cast< QAction* > ( sender() );

  if ( action != 0 && action->data().isValid() )
    type = (DataType) action->data().toUInt();

  for (auto* o_it : PluginFunctions::objects(PluginFunctions::ALL_OBJECTS, type) ) {
    o_it->source(false);
  }
}


//******************************************************************************

void DataControlPlugin::hideAll() {

  if ( ! OpenFlipper::Options::gui())
      return;

  DataType type = DATA_ALL;

  //try to find dataType restriction if called by contextMenu
  QAction* action = dynamic_cast< QAction* > ( sender() );

  if ( action != 0 && action->data().isValid() )
    type = (DataType) action->data().toUInt();

  for (auto* o_it : PluginFunctions::objects(PluginFunctions::ALL_OBJECTS, type) ) {
    o_it->hide();
  }

}


//******************************************************************************

void DataControlPlugin::showAll() {

  if ( ! OpenFlipper::Options::gui())
      return;

  DataType type = DATA_ALL;

  //try to find dataType restriction if called by contextMenu
  QAction* action = dynamic_cast< QAction* > ( sender() );

  if ( action != 0 && action->data().isValid() )
    type = (DataType) action->data().toUInt();

  for (auto* o_it : PluginFunctions::objects(PluginFunctions::ALL_OBJECTS, type) ) {
    o_it->show();
  }

}

//******************************************************************************

IdList DataControlPlugin::getTargetObjects(DataType _type) {

  IdList list;
  
  for (auto* o_it : PluginFunctions::objects(PluginFunctions::TARGET_OBJECTS, _type) )  {
    list.push_back( o_it->id() );
  }

  return list;
}

//******************************************************************************

IdList DataControlPlugin::getSourceObjects(DataType _type) {
  
  IdList list;
  
  for (auto* o_it : PluginFunctions::objects(PluginFunctions::SOURCE_OBJECTS, _type) ) {
    list.push_back( o_it->id() );
  }
    
  return list;  
}

//******************************************************************************

void DataControlPlugin::printObjectInfoToLog() {

  for (auto* o_it : PluginFunctions::objects(PluginFunctions::ALL_OBJECTS) ) {
    emit log(LOGINFO, tr("Object \"%1\" with ID %2 of type %3 ").arg(o_it->name()).arg(o_it->id()).arg(o_it->dataType().name()));
  }
}

//******************************************************************************

unsigned int DataControlPlugin::groupCount() const {
  unsigned int count = 0;
  for ( PluginFunctions::BaseObjectIterator o_it(PluginFunctions::ALL_OBJECTS,DATA_GROUP); o_it != PluginFunctions::objectsEnd(); ++o_it)
      ++count;

  return count;
}

//******************************************************************************

QString DataControlPlugin::availableDataTypeNames() const {

  QString list;

  for ( std::vector< TypeInfo >::const_iterator dataType = typesBegin(); dataType != typesEnd(); ++dataType )
    list.append(dataType->name + "\n");

  return list;
}

//******************************************************************************
bool DataControlPlugin::addObjectToGroup(int _objectId, int _groupId)
{
  BaseObject* obj = 0;
  BaseObject* group = 0;

  PluginFunctions::getObject(_objectId,obj);
  PluginFunctions::getObject(_groupId,group);

   if ( obj && group)
   {
     if (group->isGroup())
     {
       obj->setParent(group);
       return true;
     }
     else
       emit log( LOGERR, tr(" Object with id %1 is not a group").arg(_groupId));
   } else {
       if (!obj)
         emit log( LOGERR, tr( "Unable to get Object with id %1").arg(_objectId) );
       if (!_groupId)
         emit log( LOGERR, tr( "Unable to get Group with id %1").arg(_groupId) );
   }
   return false;
}

//******************************************************************************
IdList DataControlPlugin::getGroupElements(int _groupId)
{
  BaseObject* group = 0;
  PluginFunctions::getObject(_groupId,group);
  IdList result;

  for (int i = 0; i < group->childCount(); ++i)
    result.push_back(group->child(i)->id());

  return result;
}