Visualizer_Reporter.h

Go to the documentation of this file.

#ifndef SimTK_SIMBODY_VISUALIZER_REPORTER_H_
#define SimTK_SIMBODY_VISUALIZER_REPORTER_H_

/* -------------------------------------------------------------------------- *
 *                               Simbody(tm)                                  *
 * -------------------------------------------------------------------------- *
 * This is part of the SimTK biosimulation toolkit originating from           *
 * Simbios, the NIH National Center for Physics-Based Simulation of           *
 * Biological Structures at Stanford, funded under the NIH Roadmap for        *
 * Medical Research, grant U54 GM072970. See https://simtk.org/home/simbody.  *
 *                                                                            *
 * Portions copyright (c) 2010-12 Stanford University and the Authors.        *
 * Authors: Peter Eastman, Michael Sherman                                    *
 * Contributors:                                                              *
 *                                                                            *
 * 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 "SimTKcommon.h"
#include "simbody/internal/common.h"
#include "simbody/internal/Visualizer.h"

namespace SimTK {

class MultibodySystem;

class SimTK_SIMBODY_EXPORT Visualizer::Reporter : public PeriodicEventReporter {
public:
    explicit Reporter(const Visualizer& viz, Real reportInterval=Infinity);

    explicit Reporter(const MultibodySystem& sys, Real reportInterval=Infinity);
 
    ~Reporter();

    const Visualizer& getVisualizer() const;

    virtual void handleEvent(const State& state) const;

protected:
    class Impl;
    Impl* impl;
    const Impl& getImpl() const {assert(impl); return *impl;}
    Impl&       updImpl()       {assert(impl); return *impl;}
};

typedef Visualizer::Reporter VTKEventReporter;

} // namespace SimTK

#endif // SimTK_SIMBODY_VISUALIZER_REPORTER_H_