Commit e7c8c1df authored by Sreekanth Arikatla's avatar Sreekanth Arikatla
Browse files

DOC: Add documentation to the VTKRenderer and simulationManager classes

Also enforces formatting
parent 574599e6
Pipeline #95445 passed with stage
......@@ -164,7 +164,7 @@ void testLapToolController()
// Run
sdk->setActiveScene(scene);
sdk->startSimulation(SimulationStatus::PAUSED);
#endif
}
......@@ -704,7 +704,7 @@ void testObjectController()
scene->addLight(light);
// Run
sdk->setActiveScene(scene);
sdk->setActiveScene(scene);
sdk->startSimulation(SimulationStatus::RUNNING);
#endif
}
......
......@@ -76,33 +76,33 @@ public:
void setMode(const Mode mode, const bool enableVR) override;
///
/// \brief
/// \brief Updates the scene camera's position and orientation
///
void updateSceneCamera(std::shared_ptr<Camera> imstkCam);
///
/// \brief
/// \brief Updates the render delegates
///
void updateRenderDelegates();
///
/// \brief
/// \brief Returns VTK renderer
///
vtkSmartPointer<vtkRenderer> getVtkRenderer() const;
///
/// \brief Update background colors
///
virtual void updateBackground(const Vec3d color1, const Vec3d color2 = Vec3d::Zero(), const bool gradientBackground = false);
void updateBackground(const Vec3d color1, const Vec3d color2 = Vec3d::Zero(), const bool gradientBackground = false);
protected:
///
/// \brief
/// \brief Remove actors (also called props) from the scene
///
void removeActors(const std::vector<vtkSmartPointer<vtkProp>>& actorList);
///
/// \brief
/// \brief Add actors (also called props) from the scene
///
void addActors(const std::vector<vtkSmartPointer<vtkProp>>& actorList);
......@@ -124,4 +124,4 @@ protected:
};
}
#endif // ifndef imstkRenderer_h
#endif // ifndef imstkVTKRenderer_h
......@@ -55,7 +55,7 @@ public:
///
/// \brief Update background colors
///
virtual void updateBackground(const Vec3d color1, const Vec3d color2 = Vec3d::Zero(), const bool gradientBackground = false)=0;
virtual void updateBackground(const Vec3d color1, const Vec3d color2 = Vec3d::Zero(), const bool gradientBackground = false) = 0;
protected:
Renderer::Mode m_currentMode = Renderer::Mode::EMPTY;
......
......@@ -25,7 +25,6 @@
namespace imstk
{
VTKViewer::VTKViewer(SimulationManager* manager /*= nullptr*/, bool enableVR /*= false*/)
{
m_enableVR = enableVR;
......
......@@ -162,12 +162,12 @@ public:
void pauseSimulation();
///
/// \brief End the simulation
/// \brief Reset the simulation to initial state
///
void resetSimulation();
///
/// \brief
/// \brief End the simulation
///
void endSimulation();
......
......@@ -54,23 +54,23 @@ public:
///
/// \brief Set scene to be rendered
///
virtual void setActiveScene(std::shared_ptr<Scene> scene)=0;
virtual void setActiveScene(std::shared_ptr<Scene> scene) = 0;
///
/// \brief Start rendering
///
virtual void startRenderingLoop()=0;
virtual void startRenderingLoop() = 0;
///
/// \brief Terminate rendering
///
virtual void endRenderingLoop()=0;
virtual void endRenderingLoop() = 0;
///
/// \brief Setup the current renderer to render what's needed
/// based on the mode chosen
///
virtual void setRenderingMode(const Renderer::Mode mode)=0;
virtual void setRenderingMode(const Renderer::Mode mode) = 0;
///
/// \brief Get the current renderer's mode
......@@ -96,7 +96,7 @@ public:
/// \brief Set the coloring of the screen background
/// If 'gradientBackground' is false or not supplied color1 will fill the entire background
///
virtual void setBackgroundColors(const Vec3d color1, const Vec3d color2 = Vec3d::Zero(), const bool gradientBackground = false)=0;
virtual void setBackgroundColors(const Vec3d color1, const Vec3d color2 = Vec3d::Zero(), const bool gradientBackground = false) = 0;
///
/// \brief Set custom event handlers on interactor style
......@@ -122,7 +122,7 @@ protected:
std::shared_ptr<Scene> m_activeScene;
std::unordered_map<std::shared_ptr<Scene>, std::shared_ptr<Renderer>> m_rendererMap;
std::shared_ptr<ScreenCaptureUtility> m_screenCapturer; ///> Screen shot utility
std::shared_ptr<InteractorStyle> m_interactorStyle;
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment