xsi_particlecloudprimitive.h

Go to the documentation of this file.

//*****************************************************************************
//*****************************************************************************

#if (_MSC_VER > 1000) || defined(SGI_COMPILER)
#pragma once
#endif

#ifndef __XSIPARTICLECLOUDPRIMITIVE_H__
#define __XSIPARTICLECLOUDPRIMITIVE_H__

#include <xsi_primitive.h>
#include <xsi_value.h>
#include <xsi_status.h>
#include <xsi_longarray.h>
#include <xsi_particle.h>
#include <xsi_doublearray.h>

namespace XSI {

//*****************************************************************************
//*****************************************************************************

class SICPPSDKDECL ParticleCloudPrimitive : public Primitive
{
public:
    ParticleCloudPrimitive();

    ~ParticleCloudPrimitive();

    ParticleCloudPrimitive(const CRef& in_ref);

    ParticleCloudPrimitive(const ParticleCloudPrimitive& in_obj);

    bool IsA( siClassID in_ClassID) const;

    siClassID GetClassID() const;

    ParticleCloudPrimitive& operator=(const ParticleCloudPrimitive& in_obj);

    ParticleCloudPrimitive& operator=(const CRef& in_ref);

    CStatus AddParticles( LONG in_NbParticles, const CRef& in_ParType ) ;

    /* Obsolete function to add particles to a cloud.
    \deprecated 4.0 Maintained for backward compatibility only.
    \param in_NbParticles Number of new particles to add.
    \param in_ParType Reference to an existing particle type object.
    */
    CStatus AddParticles( LONG in_NbParticles, CRef& in_ParType ) ;

    CStatus RemoveParticles(const CLongArray & in_IndexArray ) ;

    CStatus RemoveParticlesWithIDs(const CLongArray & in_IDArray ) ;


    LONG GetCount() const ;

    Particle GetParticle( LONG in_index ) const ;

    CRefArray GetParticleTypes() const ;

    Particle FindParticle( LONG in_ID ) const ;

    CStatus PutPositionArray( const CDoubleArray& in_values ) ;

    CStatus GetPositionArray( CDoubleArray& out_values ) ;

    CStatus PutVelocityArray( const CDoubleArray& in_values ) ;

    CStatus GetVelocityArray( CDoubleArray& out_values ) ;

    CStatus PutRotationArray( const CDoubleArray& in_values ) ;

    CStatus GetRotationArray( CDoubleArray& out_values ) ;

    CStatus PutAngularVelocityArray( const CDoubleArray& in_values ) ;

    CStatus GetAngularVelocityArray( CDoubleArray& out_values ) ;

    CStatus PutUVWArray( const CDoubleArray& in_values ) ;

    CStatus GetUVWArray( CDoubleArray& out_values ) ;

    CStatus PutColorArray( const CDoubleArray& in_values ) ;

    CStatus GetColorArray( CDoubleArray& out_values ) ;

    CStatus PutSizeArray( const CDoubleArray& in_values ) ;

    CStatus GetSizeArray( CDoubleArray& out_values ) ;

    CStatus PutSpriteAngleArray( const CDoubleArray& in_values ) ;

    CStatus GetSpriteAngleArray( CDoubleArray& out_values ) ;

    CStatus PutMassArray( const CDoubleArray& in_values ) ;

    CStatus GetMassArray( CDoubleArray& out_values ) ;

    CStatus GetDensityArray( CDoubleArray& out_values ) ;

    CStatus GetPressureArray( CDoubleArray& out_values ) ;

    CStatus GetPathLengthArray( CDoubleArray& out_values ) ;

    CStatus PutAgeArray( const CLongArray& in_values ) ;

    CStatus GetAgeArray( CLongArray& out_values ) ;

    CStatus PutSeedArray( const CLongArray& in_values ) ;

    CStatus GetSeedArray( CLongArray& out_values ) ;

    CStatus PutAgeLimitArray( const CLongArray& in_values ) ;

    CStatus GetAgeLimitArray( CLongArray& out_values ) ;

    CStatus PutSpriteIndexArray( const CLongArray& in_values ) ;

    CStatus GetSpriteIndexArray( CLongArray& out_values ) ;

    CStatus PutTypeIDArray( const CLongArray& in_values ) ;

    CStatus GetTypeIDArray( CLongArray& out_values ) ;

    CStatus GetIDArray( CLongArray& in_values ) ;

    private:
    ParticleCloudPrimitive * operator&() const;
    ParticleCloudPrimitive * operator&();
};

};
#endif // __XSIPARTICLECLOUDPRIMITIVE_H__