ModelVisualPreferences.h

#ifndef OPENSIM_MODEL_VISUAL_PREFERENCES_H_
#define OPENSIM_MODEL_VISUAL_PREFERENCES_H_
/* -------------------------------------------------------------------------- *
 *                   OpenSim:  ModelVisualPreferences.h                       *
 * -------------------------------------------------------------------------- *
 * The OpenSim API is a toolkit for musculoskeletal modeling and simulation.  *
 * See http://opensim.stanford.edu and the NOTICE file for more information.  *
 * OpenSim is developed at Stanford University and supported by the US        *
 * National Institutes of Health (U54 GM072970, R24 HD065690) and by DARPA    *
 * through the Warrior Web program.                                           *
 *                                                                            *
 * Copyright (c) 2005-2017 Stanford University and the Authors                *
 * Author(s): Ayman Habib                                                     *
 *                                                                            *
 * 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.                                             *
 * -------------------------------------------------------------------------- */


// INCLUDE
#include <OpenSim/Simulation/osimSimulationDLL.h>
#include <OpenSim/Common/ModelDisplayHints.h>

namespace OpenSim {

class Body;
class Model;


//=============================================================================
//=============================================================================
/**
 A class that holds the Visual Preferences of a full OpenSim Model 
 displayed in Visualizer. Initially these are serializable ModelDisplayHints 
 but in the future can be expanded to include search paths for Mesh files, 
 Texture, Renderer preferences, lights, cameras etc. attached to Model.
 
 * @author Ayman Habib
 * @version 1.0
 */
class OSIMSIMULATION_API ModelVisualPreferences : public Object {
    OpenSim_DECLARE_CONCRETE_OBJECT(ModelVisualPreferences, Object);
public:
    //==========================================================================
    // PROPERTIES
    //==========================================================================
    OpenSim_DECLARE_UNNAMED_PROPERTY(ModelDisplayHints,
        "Model display preferences");
    //--------------------------------------------------------------------------
    // CONSTRUCTION
    //--------------------------------------------------------------------------
public:
    ModelVisualPreferences() {
        constructProperties();
    }
    virtual ~ModelVisualPreferences() {};

    bool visualize() const {
        return _visualize;
    }
    void setVisualize(bool visualizationStatus) {
        _visualize = visualizationStatus;
    }
private:
    void constructProperties() {
        constructProperty_ModelDisplayHints(ModelDisplayHints());
    }
    bool _visualize;
//=============================================================================
};  // END of class ModelVisualPreferences
//=============================================================================
//=============================================================================

} // end of namespace OpenSim

#endif // OPENSIM_MODEL_VISUAL_PREFERENCES_H_