gz/rendering/ParticleEmitter.hh

Go to the documentation of this file.

/*
 * Copyright (C) 2020 Open Source Robotics Foundation
 *
 * 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 IGNITION_RENDERING_PARTICLEEMITTER_HH_
#define IGNITION_RENDERING_PARTICLEEMITTER_HH_
 
#include <string>
#include "ignition/math/Color.hh"
#include "ignition/math/Pose3.hh"
#include "ignition/math/Vector3.hh"
#include "ignition/rendering/config.hh"
#include "ignition/rendering/Export.hh"
#include "ignition/rendering/RenderTypes.hh"
#include "ignition/rendering/Visual.hh"
 
namespace ignition
{
  namespace rendering
  {
    inline namespace IGNITION_RENDERING_VERSION_NAMESPACE {
    //
    enum IGNITION_RENDERING_VISIBLE EmitterType
    {
      EM_POINT            = 0,
 
      EM_BOX              = 1,
 
      EM_CYLINDER         = 2,
 
      EM_ELLIPSOID        = 3,
 
      EM_NUM_EMITTERS     = 4,
    };
 
    //
    class IGNITION_RENDERING_VISIBLE ParticleEmitter :
      public virtual Visual
    {
      public: virtual ~ParticleEmitter() {}
 
      public: virtual EmitterType Type() const = 0;
 
      public: virtual void SetType(const EmitterType _type) = 0;
 
      public: virtual ignition::math::Vector3d EmitterSize() const = 0;
 
      public: virtual void SetEmitterSize(
                  const ignition::math::Vector3d &_size) = 0;
 
      public: virtual double Rate() const = 0;
 
      public: virtual void SetRate(double _rate) = 0;
 
      public: virtual double Duration() const = 0;
 
      public: virtual void SetDuration(double _duration) = 0;
 
      public: virtual bool Emitting() const = 0;
 
      public: virtual void SetEmitting(bool _enable) = 0;
 
      public: virtual ignition::math::Vector3d ParticleSize() const = 0;
 
      public: virtual void SetParticleSize(
                  const ignition::math::Vector3d &_size) = 0;
 
      public: virtual double Lifetime() const = 0;
 
      public: virtual void SetLifetime(double _lifetime) = 0;
 
      public: virtual MaterialPtr Material() const = 0;
 
      public: virtual void SetMaterial(const MaterialPtr &_material) = 0;
 
      public: virtual double MinVelocity() const = 0;
 
      public: virtual double MaxVelocity() const = 0;
 
      public: virtual void SetVelocityRange(double _minVelocity,
                                            double _maxVelocity) = 0;
 
      public: virtual ignition::math::Color ColorStart() const = 0;
 
      public: virtual ignition::math::Color ColorEnd() const = 0;
 
      public: virtual void SetColorRange(
                  const ignition::math::Color &_colorStart,
                  const ignition::math::Color &_colorEnd) = 0;
 
      public: virtual double ScaleRate() const = 0;
 
      public: virtual void SetScaleRate(double _scaleRate) = 0;
 
      public: virtual std::string ColorRangeImage() const = 0;
 
      public: virtual void SetColorRangeImage(const std::string &_image) = 0;
 
      public: virtual float ParticleScatterRatio() const = 0;
 
      public: virtual void SetParticleScatterRatio(float _ratio) = 0;
    };
    }
  }
}
#endif