Simbody  3.5
DecorationGenerator.h
Go to the documentation of this file.
1 #ifndef SimTK_SimTKCOMMON_DECORATION_GENERATOR_H_
2 #define SimTK_SimTKCOMMON_DECORATION_GENERATOR_H_
3 
4 /* -------------------------------------------------------------------------- *
5  * Simbody(tm): SimTKcommon *
6  * -------------------------------------------------------------------------- *
7  * This is part of the SimTK biosimulation toolkit originating from *
8  * Simbios, the NIH National Center for Physics-Based Simulation of *
9  * Biological Structures at Stanford, funded under the NIH Roadmap for *
10  * Medical Research, grant U54 GM072970. See https://simtk.org/home/simbody. *
11  * *
12  * Portions copyright (c) 2011-12 Stanford University and the Authors. *
13  * Authors: Peter Eastman *
14  * Contributors: *
15  * *
16  * Licensed under the Apache License, Version 2.0 (the "License"); you may *
17  * not use this file except in compliance with the License. You may obtain a *
18  * copy of the License at http://www.apache.org/licenses/LICENSE-2.0. *
19  * *
20  * Unless required by applicable law or agreed to in writing, software *
21  * distributed under the License is distributed on an "AS IS" BASIS, *
22  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. *
23  * See the License for the specific language governing permissions and *
24  * limitations under the License. *
25  * -------------------------------------------------------------------------- */
26 
27 #include "SimTKcommon/basics.h"
28 
29 namespace SimTK {
30 
31 class State;
32 
46 public:
52  virtual void generateDecorations(const State& state,
53  Array_<DecorativeGeometry>& geometry) = 0;
54 
57  virtual ~DecorationGenerator() {}
58 };
59 
60 } // namespace SimTK
61 
62 #endif // SimTK_SimTKCOMMON_DECORATION_GENERATOR_H_
This is the top-level SimTK namespace into which all SimTK names are placed to avoid collision with o...
Definition: Assembler.h:37
This object is intended to contain all state information for a SimTK::System, except topological info...
Definition: State.h:276
A DecorationGenerator is used to define geometry that may change over the course of a simulation...
Definition: DecorationGenerator.h:45
The SimTK::Array_<T> container class is a plug-compatible replacement for the C++ standard template l...
Definition: Array.h:50
virtual ~DecorationGenerator()
Destructor is virtual; be sure to override it if you have something to clean up at the end...
Definition: DecorationGenerator.h:57
Includes internal headers providing declarations for the basic SimTK Core classes.
virtual void generateDecorations(const State &state, Array_< DecorativeGeometry > &geometry)=0
This will be called every time a new State is about to be visualized.