Sink.h
Go to the documentation of this file.
// This file is a part of the OpenSurgSim project.
// Copyright 2015, SimQuest Solutions Inc.
//
// 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.
#ifndef SURGSIM_PARTICLES_SINK_H
#define SURGSIM_PARTICLES_SINK_H
#include <memory>
#include "SurgSim/Framework/Behavior.h"
#include "SurgSim/Framework/ObjectFactory.h"
namespace SurgSim
{
namespace Collision
{
class Representation;
};
namespace Framework
{
class Component;
class Logger;
};
namespace Particles
{
class Representation;
SURGSIM_STATIC_REGISTRATION(Sink);
class Sink : public SurgSim::Framework::Behavior
{
public:
explicit Sink(const std::string& name);
SURGSIM_CLASSNAME(SurgSim::Particles::Sink);
void setTarget(const std::shared_ptr<SurgSim::Framework::Component>& target);
std::shared_ptr<SurgSim::Framework::Component> getTarget();
void setCollisionRepresentation(const std::shared_ptr<SurgSim::Framework::Component>& representation);
std::shared_ptr<SurgSim::Framework::Component> getCollisionRepresentation();
void update(double dt) override;
int getTargetManagerType() const override;
private:
bool doInitialize() override;
bool doWakeUp() override;
std::shared_ptr<SurgSim::Collision::Representation> m_collisionRepresentation;
std::shared_ptr<SurgSim::Particles::Representation> m_target;
std::shared_ptr<SurgSim::Framework::Logger> m_logger;
};
};
};
#endif // SURGSIM_PARTICLES_SINK_H
SurgSim
Definition: CompoundShapeToGraphics.cpp:29
SurgSim::Particles::Sink::m_collisionRepresentation
std::shared_ptr< SurgSim::Collision::Representation > m_collisionRepresentation
Definition: Sink.h:83
SurgSim::Particles::Sink
Sink removes particles from a ParticleSystem.
Definition: Sink.h:47
ObjectFactory.h
SurgSim::Particles::Particles
DataStructures::Vertices< ParticleData > Particles
Definition: Particles.h:53
Behavior.h
SURGSIM_CLASSNAME
#define SURGSIM_CLASSNAME(ClassName)
Declare the class name of a class with the appropriate function header, do not use quotes...
Definition: Macros.h:21
SurgSim::Framework::Behavior
Behaviors perform actions.
Definition: Behavior.h:40
SurgSim::Particles::Sink::m_logger
std::shared_ptr< SurgSim::Framework::Logger > m_logger
Definition: Sink.h:87
SurgSim::Particles::Sink::m_target
std::shared_ptr< SurgSim::Particles::Representation > m_target
Definition: Sink.h:85