Public API Reference

imesh/emit.h

Go to the documentation of this file.

/*
    Copyright (C) 2000 by Jorrit Tyberghein
    Copyright (C) 2001 by W.C.A. Wijngaards

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Library General Public
    License as published by the Free Software Foundation; either
    version 2 of the License, or (at your option) any later version.

    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Library General Public License for more details.

    You should have received a copy of the GNU Library General Public
    License along with this library; if not, write to the Free
    Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/

#ifndef __CS_IMESH_EMIT_H__
#define __CS_IMESH_EMIT_H__

#include "csutil/scf_interface.h"

class csColor;
class csVector3;

struct iEmitGen3D : public virtual iBase
{
  SCF_INTERFACE(iEmitGen3D, 2, 0, 0);

  virtual void GetValue(csVector3& value, csVector3 &given) = 0;
};

struct iEmitFixed : public iEmitGen3D
{
  SCF_INTERFACE(iEmitFixed, 2, 0, 0);

  virtual void SetValue(const csVector3& value) = 0;
};

struct iEmitSphere : public iEmitGen3D
{
  SCF_INTERFACE(iEmitSphere, 2, 0, 0);

  virtual void SetContent(const csVector3& center, float min, float max) = 0;
  virtual void GetContent(csVector3& center, float& min, float& max) = 0;
};

struct iEmitBox : public iEmitGen3D
{
  SCF_INTERFACE(iEmitBox, 2, 0, 0);

  virtual void SetContent(const csVector3& min, const csVector3& max) = 0;
  virtual void GetContent(csVector3& min, csVector3& max) = 0;
};

struct iEmitCone : public iEmitGen3D
{
  SCF_INTERFACE(iEmitCone, 2, 0, 0);

  virtual void SetContent(const csVector3& origin, float elevation,
    float azimuth, float aperture, float min, float max) = 0;
  virtual void GetContent(csVector3& origin, float& elevation,
    float& azimuth, float& aperture, float& min, float& max) = 0;
};

struct iEmitMix : public iEmitGen3D
{
  SCF_INTERFACE(iEmitMix, 2, 0, 0);

  virtual void AddEmitter(float weight, iEmitGen3D* emit) = 0;
  virtual void RemoveEmitter(int num) = 0;
  virtual float GetTotalWeight() = 0;
  virtual int GetEmitterCount() = 0;
  virtual void AdjustEmitterWeight(int num,float weight) = 0;
  virtual void GetContent(int num, float& weight, iEmitGen3D*& emit) = 0;
};

struct iEmitLine : public iEmitGen3D
{
  SCF_INTERFACE(iEmitLine, 2, 0, 0);

  virtual void SetContent(const csVector3& start, const csVector3& end) = 0;
  virtual void GetContent(csVector3& start, csVector3& end) = 0;
};

struct iEmitCylinder : public iEmitGen3D
{
  SCF_INTERFACE(iEmitCylinder, 2, 0, 0);

  virtual void SetContent(const csVector3& start, const csVector3& end,
    float min, float max) = 0;
  virtual void GetContent(csVector3& start, csVector3& end,
    float& min, float& max) = 0;
};

struct iEmitSphereTangent : public iEmitGen3D
{
  SCF_INTERFACE(iEmitSphereTangent, 2, 0, 0);

  virtual void SetContent(const csVector3& center, float min, float max) = 0;
  virtual void GetContent(csVector3& center, float& min, float& max) = 0;
};

struct iEmitCylinderTangent : public iEmitGen3D
{
  SCF_INTERFACE(iEmitCylinderTangent, 2, 0, 0);

  virtual void SetContent(const csVector3& start, const csVector3& end,
    float min, float max) = 0;
  virtual void GetContent(csVector3& start, csVector3& end,
    float& min, float& max) = 0;
};

struct iEmitFactoryState : public virtual iBase
{
  SCF_INTERFACE(iEmitFactoryState, 2, 0, 0);

  virtual csRef<iEmitFixed> CreateFixed() = 0;
  virtual csRef<iEmitBox> CreateBox() = 0;
  virtual csRef<iEmitSphere> CreateSphere() = 0;
  virtual csRef<iEmitCone> CreateCone() = 0;
  virtual csRef<iEmitMix> CreateMix() = 0;
  virtual csRef<iEmitLine> CreateLine() = 0;
  virtual csRef<iEmitCylinder> CreateCylinder() = 0;
  virtual csRef<iEmitSphereTangent> CreateSphereTangent() = 0;
  virtual csRef<iEmitCylinderTangent> CreateCylinderTangent() = 0;
};

struct iEmitState : public virtual iBase
{
  SCF_INTERFACE(iEmitState, 2, 0, 0);

  virtual void SetParticleCount (int num) = 0;
  virtual size_t GetParticleCount () const = 0;
  virtual void SetLighting (bool l) = 0;
  virtual bool GetLighting () const = 0;
  virtual void SetParticleTime(int ttl) = 0;
  virtual int GetParticleTime() const = 0;
  virtual void SetStartPosEmit(iEmitGen3D *emit) = 0;
  virtual iEmitGen3D* GetStartPosEmit() const = 0;
  virtual void SetStartSpeedEmit(iEmitGen3D *emit) = 0;
  virtual iEmitGen3D* GetStartSpeedEmit() const = 0;
  virtual void SetStartAccelEmit(iEmitGen3D *emit) = 0;
  virtual iEmitGen3D* GetStartAccelEmit() const = 0;
  virtual void SetAttractorEmit(iEmitGen3D *emit) = 0;
  virtual iEmitGen3D* GetAttractorEmit() const = 0;

  virtual void SetAttractorForce(float f) = 0;
  virtual float GetAttractorForce() const = 0;

  virtual void SetFieldSpeedEmit(iEmitGen3D *emit) = 0;
  virtual iEmitGen3D* GetFieldSpeedEmit() const = 0;
  virtual void SetFieldAccelEmit(iEmitGen3D *emit) = 0;
  virtual iEmitGen3D* GetFieldAccelEmit() const = 0;

  virtual void AddAge(int time, const csColor& color, float alpha,
    float swirl, float rotspeed, float scale) = 0;
  virtual int GetAgingCount() const = 0;
  virtual void GetAgingMoment(int i, int& time, csColor& color, float &alpha,
    float& swirl, float& rotspeed, float& scale) = 0;
  virtual void RemoveAge(int time, const csColor& color, float alpha,
        float swirl, float rotspeed, float scale) = 0;
  virtual void ReplaceAge(int time, const csColor& color, float alpha,
    float swirl, float rotspeed, float scale) = 0;

  virtual void SetRectParticles(float w, float h) = 0;
  virtual void SetRegularParticles(int n, float radius) = 0;
  virtual bool UsingRectParticles() const = 0;
  virtual void GetRectParticles(float &w, float &h) const = 0;
  virtual void GetRegularParticles(int& n, float& radius) const = 0;

  virtual void SetContainerBox(bool enabled, const csVector3& min, 
    const csVector3& max) = 0;
  virtual bool GetContainerBox(csVector3& min, csVector3& max) const = 0;
};

#endif // __CS_IMESH_EMIT_H__

---