Ignition Msgs

API Reference

8.2.0

#include <particle_emitter.pb.h>

Public Types

typedef ParticleEmitter_EmitterType EmitterType
 

Public Member Functions

 ParticleEmitter ()
 
 ParticleEmitter (const ParticleEmitter &from)
 
virtual ~ParticleEmitter ()
 
int ByteSize () const
 
void Clear ()
 
void clear_color_end ()
 
void clear_color_range_image ()
 
void clear_color_start ()
 
void clear_duration ()
 
void clear_emitting ()
 
void clear_header ()
 
void clear_id ()
 
void clear_lifetime ()
 
void clear_material ()
 
void clear_max_velocity ()
 
void clear_min_velocity ()
 
void clear_name ()
 
void clear_particle_scatter_ratio ()
 
void clear_particle_size ()
 
void clear_pose ()
 
void clear_rate ()
 
void clear_scale_rate ()
 
void clear_size ()
 
void clear_topic ()
 
void clear_type ()
 
const ::ignition::msgs::Colorcolor_end () const
 
const ::ignition::msgs::StringMsgcolor_range_image () const
 
const ::ignition::msgs::Colorcolor_start () const
 
void CopyFrom (const ::google::protobuf::Message &from)
 
void CopyFrom (const ParticleEmitter &from)
 
const ::ignition::msgs::Floatduration () const
 
const ::ignition::msgs::Booleanemitting () const
 
int GetCachedSize () const
 
::google::protobuf::Metadata GetMetadata () const
 
bool has_color_end () const
 
bool has_color_range_image () const
 
bool has_color_start () const
 
bool has_duration () const
 
bool has_emitting () const
 
bool has_header () const
 
bool has_lifetime () const
 
bool has_material () const
 
bool has_max_velocity () const
 
bool has_min_velocity () const
 
bool has_particle_scatter_ratio () const
 
bool has_particle_size () const
 
bool has_pose () const
 
bool has_rate () const
 
bool has_scale_rate () const
 
bool has_size () const
 
bool has_topic () const
 
const ::ignition::msgs::Headerheader () const
 
::google::protobuf::uint32 id () const
 
::google::protobuf::uint8 * InternalSerializeWithCachedSizesToArray (bool deterministic, ::google::protobuf::uint8 *output) const
 
bool IsInitialized () const
 
const ::ignition::msgs::Floatlifetime () const
 
const ::ignition::msgs::Materialmaterial () const
 
const ::ignition::msgs::Floatmax_velocity () const
 
void MergeFrom (const ::google::protobuf::Message &from)
 
void MergeFrom (const ParticleEmitter &from)
 
bool MergePartialFromCodedStream (::google::protobuf::io::CodedInputStream *input)
 
const ::ignition::msgs::Floatmin_velocity () const
 
::ignition::msgs::Colormutable_color_end ()
 
::ignition::msgs::StringMsgmutable_color_range_image ()
 
::ignition::msgs::Colormutable_color_start ()
 
::ignition::msgs::Floatmutable_duration ()
 
::ignition::msgs::Booleanmutable_emitting ()
 
::ignition::msgs::Headermutable_header ()
 
::ignition::msgs::Floatmutable_lifetime ()
 
::ignition::msgs::Materialmutable_material ()
 
::ignition::msgs::Floatmutable_max_velocity ()
 
::ignition::msgs::Floatmutable_min_velocity ()
 
::std::stringmutable_name ()
 
::ignition::msgs::Floatmutable_particle_scatter_ratio ()
 
::ignition::msgs::Vector3dmutable_particle_size ()
 
::ignition::msgs::Posemutable_pose ()
 
::ignition::msgs::Floatmutable_rate ()
 
::ignition::msgs::Floatmutable_scale_rate ()
 
::ignition::msgs::Vector3dmutable_size ()
 
::ignition::msgs::StringMsgmutable_topic ()
 
const ::std::stringname () const
 
ParticleEmitterNew () const
 
ParticleEmitterNew (::google::protobuf::Arena *arena) const
 
ParticleEmitteroperator= (const ParticleEmitter &from)
 
const ::ignition::msgs::Floatparticle_scatter_ratio () const
 
const ::ignition::msgs::Vector3dparticle_size () const
 
const ::ignition::msgs::Posepose () const
 
const ::ignition::msgs::Floatrate () const
 
::ignition::msgs::Colorrelease_color_end ()
 
::ignition::msgs::StringMsgrelease_color_range_image ()
 
::ignition::msgs::Colorrelease_color_start ()
 
::ignition::msgs::Floatrelease_duration ()
 
::ignition::msgs::Booleanrelease_emitting ()
 
::ignition::msgs::Headerrelease_header ()
 
::ignition::msgs::Floatrelease_lifetime ()
 
::ignition::msgs::Materialrelease_material ()
 
::ignition::msgs::Floatrelease_max_velocity ()
 
::ignition::msgs::Floatrelease_min_velocity ()
 
::std::stringrelease_name ()
 
::ignition::msgs::Floatrelease_particle_scatter_ratio ()
 
::ignition::msgs::Vector3drelease_particle_size ()
 
::ignition::msgs::Poserelease_pose ()
 
::ignition::msgs::Floatrelease_rate ()
 
::ignition::msgs::Floatrelease_scale_rate ()
 
::ignition::msgs::Vector3drelease_size ()
 
::ignition::msgs::StringMsgrelease_topic ()
 
const ::ignition::msgs::Floatscale_rate () const
 
void SerializeWithCachedSizes (::google::protobuf::io::CodedOutputStream *output) const
 
::google::protobuf::uint8 * SerializeWithCachedSizesToArray (::google::protobuf::uint8 *output) const
 
void set_allocated_color_end (::ignition::msgs::Color *color_end)
 
void set_allocated_color_range_image (::ignition::msgs::StringMsg *color_range_image)
 
void set_allocated_color_start (::ignition::msgs::Color *color_start)
 
void set_allocated_duration (::ignition::msgs::Float *duration)
 
void set_allocated_emitting (::ignition::msgs::Boolean *emitting)
 
void set_allocated_header (::ignition::msgs::Header *header)
 
void set_allocated_lifetime (::ignition::msgs::Float *lifetime)
 
void set_allocated_material (::ignition::msgs::Material *material)
 
void set_allocated_max_velocity (::ignition::msgs::Float *max_velocity)
 
void set_allocated_min_velocity (::ignition::msgs::Float *min_velocity)
 
void set_allocated_name (::std::string *name)
 
void set_allocated_particle_scatter_ratio (::ignition::msgs::Float *particle_scatter_ratio)
 
void set_allocated_particle_size (::ignition::msgs::Vector3d *particle_size)
 
void set_allocated_pose (::ignition::msgs::Pose *pose)
 
void set_allocated_rate (::ignition::msgs::Float *rate)
 
void set_allocated_scale_rate (::ignition::msgs::Float *scale_rate)
 
void set_allocated_size (::ignition::msgs::Vector3d *size)
 
void set_allocated_topic (::ignition::msgs::StringMsg *topic)
 
void set_id (::google::protobuf::uint32 value)
 
void set_name (const ::std::string &value)
 
void set_name (const char *value)
 
void set_name (const char *value, size_t size)
 
void set_type (::ignition::msgs::ParticleEmitter_EmitterType value)
 
const ::ignition::msgs::Vector3dsize () const
 
void Swap (ParticleEmitter *other)
 
const ::ignition::msgs::StringMsgtopic () const
 
::ignition::msgs::ParticleEmitter_EmitterType type () const
 

Static Public Member Functions

static const ParticleEmitterdefault_instance ()
 
static const ::google::protobuf::Descriptor * descriptor ()
 
static const ::google::protobuf::EnumDescriptor * EmitterType_descriptor ()
 
static bool EmitterType_IsValid (int value)
 
static const ::std::stringEmitterType_Name (EmitterType value)
 
static bool EmitterType_Parse (const ::std::string &name, EmitterType *value)
 

Static Public Attributes

static const EmitterType BOX
 
static const EmitterType CYLINDER
 
static const EmitterType ELLIPSOID
 
static const int EmitterType_ARRAYSIZE
 
static const EmitterType EmitterType_MAX
 
static const EmitterType EmitterType_MIN
 
static const int kColorEndFieldNumber = 16
 
static const int kColorRangeImageFieldNumber = 18
 
static const int kColorStartFieldNumber = 15
 
static const int kDurationFieldNumber = 8
 
static const int kEmittingFieldNumber = 9
 
static const int kHeaderFieldNumber = 1
 
static const int kIdFieldNumber = 3
 
static const int kLifetimeFieldNumber = 11
 
static const int kMaterialFieldNumber = 12
 
static const int kMaxVelocityFieldNumber = 14
 
static const int kMinVelocityFieldNumber = 13
 
static const int kNameFieldNumber = 2
 
static const int kParticleScatterRatioFieldNumber = 20
 
static const int kParticleSizeFieldNumber = 10
 
static const int kPoseFieldNumber = 5
 
static const int kRateFieldNumber = 7
 
static const int kScaleRateFieldNumber = 17
 
static const int kSizeFieldNumber = 6
 
static const int kTopicFieldNumber = 19
 
static const int kTypeFieldNumber = 4
 
static const EmitterType POINT
 

Friends

void IGNITION_MSGS_VISIBLE protobuf_AddDesc_ignition_2fmsgs_2fparticle_5femitter_2eproto ()
 
void protobuf_AssignDesc_ignition_2fmsgs_2fparticle_5femitter_2eproto ()
 
void protobuf_ShutdownFile_ignition_2fmsgs_2fparticle_5femitter_2eproto ()
 

Member Typedef Documentation

◆ EmitterType

Constructor & Destructor Documentation

◆ ParticleEmitter() [1/2]

◆ ~ParticleEmitter()

virtual ~ParticleEmitter ( )
virtual

◆ ParticleEmitter() [2/2]

ParticleEmitter ( const ParticleEmitter from)

Member Function Documentation

◆ ByteSize()

int ByteSize ( ) const

◆ Clear()

void Clear ( )

◆ clear_color_end()

void clear_color_end ( )
inline

◆ clear_color_range_image()

void clear_color_range_image ( )
inline

◆ clear_color_start()

void clear_color_start ( )
inline

◆ clear_duration()

void clear_duration ( )
inline

◆ clear_emitting()

void clear_emitting ( )
inline

◆ clear_header()

void clear_header ( )
inline

◆ clear_id()

void clear_id ( )
inline

◆ clear_lifetime()

void clear_lifetime ( )
inline

◆ clear_material()

void clear_material ( )
inline

◆ clear_max_velocity()

void clear_max_velocity ( )
inline

◆ clear_min_velocity()

void clear_min_velocity ( )
inline

◆ clear_name()

void clear_name ( )
inline

◆ clear_particle_scatter_ratio()

void clear_particle_scatter_ratio ( )
inline

◆ clear_particle_size()

void clear_particle_size ( )
inline

◆ clear_pose()

void clear_pose ( )
inline

◆ clear_rate()

void clear_rate ( )
inline

◆ clear_scale_rate()

void clear_scale_rate ( )
inline

◆ clear_size()

void clear_size ( )
inline

◆ clear_topic()

void clear_topic ( )
inline

◆ clear_type()

void clear_type ( )
inline

◆ color_end()

const ::ignition::msgs::Color & color_end ( ) const
inline

◆ color_range_image()

const ::ignition::msgs::StringMsg & color_range_image ( ) const
inline

◆ color_start()

const ::ignition::msgs::Color & color_start ( ) const
inline

◆ CopyFrom() [1/2]

void CopyFrom ( const ::google::protobuf::Message &  from)

◆ CopyFrom() [2/2]

void CopyFrom ( const ParticleEmitter from)

◆ default_instance()

static const ParticleEmitter& default_instance ( )
static

◆ descriptor()

static const ::google::protobuf::Descriptor* descriptor ( )
static

◆ duration()

const ::ignition::msgs::Float & duration ( ) const
inline

◆ EmitterType_descriptor()

static const ::google::protobuf::EnumDescriptor* EmitterType_descriptor ( )
inlinestatic

◆ EmitterType_IsValid()

static bool EmitterType_IsValid ( int  value)
inlinestatic

◆ EmitterType_Name()

static const ::std::string& EmitterType_Name ( EmitterType  value)
inlinestatic

◆ EmitterType_Parse()

static bool EmitterType_Parse ( const ::std::string name,
EmitterType value 
)
inlinestatic

◆ emitting()

const ::ignition::msgs::Boolean & emitting ( ) const
inline

◆ GetCachedSize()

int GetCachedSize ( ) const
inline

◆ GetMetadata()

::google::protobuf::Metadata GetMetadata ( ) const

◆ has_color_end()

bool has_color_end ( ) const
inline

◆ has_color_range_image()

bool has_color_range_image ( ) const
inline

◆ has_color_start()

bool has_color_start ( ) const
inline

◆ has_duration()

bool has_duration ( ) const
inline

◆ has_emitting()

bool has_emitting ( ) const
inline

◆ has_header()

bool has_header ( ) const
inline

◆ has_lifetime()

bool has_lifetime ( ) const
inline

◆ has_material()

bool has_material ( ) const
inline

◆ has_max_velocity()

bool has_max_velocity ( ) const
inline

◆ has_min_velocity()

bool has_min_velocity ( ) const
inline

◆ has_particle_scatter_ratio()

bool has_particle_scatter_ratio ( ) const
inline

◆ has_particle_size()

bool has_particle_size ( ) const
inline

◆ has_pose()

bool has_pose ( ) const
inline

◆ has_rate()

bool has_rate ( ) const
inline

◆ has_scale_rate()

bool has_scale_rate ( ) const
inline

◆ has_size()

bool has_size ( ) const
inline

◆ has_topic()

bool has_topic ( ) const
inline

◆ header()

const ::ignition::msgs::Header & header ( ) const
inline

◆ id()

google::protobuf::uint32 id ( ) const
inline

◆ InternalSerializeWithCachedSizesToArray()

::google::protobuf::uint8* InternalSerializeWithCachedSizesToArray ( bool  deterministic,
::google::protobuf::uint8 *  output 
) const

◆ IsInitialized()

bool IsInitialized ( ) const

◆ lifetime()

const ::ignition::msgs::Float & lifetime ( ) const
inline

◆ material()

const ::ignition::msgs::Material & material ( ) const
inline

◆ max_velocity()

const ::ignition::msgs::Float & max_velocity ( ) const
inline

◆ MergeFrom() [1/2]

void MergeFrom ( const ::google::protobuf::Message &  from)

◆ MergeFrom() [2/2]

void MergeFrom ( const ParticleEmitter from)

◆ MergePartialFromCodedStream()

bool MergePartialFromCodedStream ( ::google::protobuf::io::CodedInputStream *  input)

◆ min_velocity()

const ::ignition::msgs::Float & min_velocity ( ) const
inline

◆ mutable_color_end()

ignition::msgs::Color * mutable_color_end ( )
inline

◆ mutable_color_range_image()

ignition::msgs::StringMsg * mutable_color_range_image ( )
inline

◆ mutable_color_start()

ignition::msgs::Color * mutable_color_start ( )
inline

◆ mutable_duration()

ignition::msgs::Float * mutable_duration ( )
inline

◆ mutable_emitting()

ignition::msgs::Boolean * mutable_emitting ( )
inline

◆ mutable_header()

ignition::msgs::Header * mutable_header ( )
inline

◆ mutable_lifetime()

ignition::msgs::Float * mutable_lifetime ( )
inline

◆ mutable_material()

ignition::msgs::Material * mutable_material ( )
inline

◆ mutable_max_velocity()

ignition::msgs::Float * mutable_max_velocity ( )
inline

◆ mutable_min_velocity()

ignition::msgs::Float * mutable_min_velocity ( )
inline

◆ mutable_name()

std::string * mutable_name ( )
inline

◆ mutable_particle_scatter_ratio()

ignition::msgs::Float * mutable_particle_scatter_ratio ( )
inline

◆ mutable_particle_size()

ignition::msgs::Vector3d * mutable_particle_size ( )
inline

◆ mutable_pose()

ignition::msgs::Pose * mutable_pose ( )
inline

◆ mutable_rate()

ignition::msgs::Float * mutable_rate ( )
inline

◆ mutable_scale_rate()

ignition::msgs::Float * mutable_scale_rate ( )
inline

◆ mutable_size()

ignition::msgs::Vector3d * mutable_size ( )
inline

◆ mutable_topic()

ignition::msgs::StringMsg * mutable_topic ( )
inline

◆ name()

const ::std::string & name ( ) const
inline

◆ New() [1/2]

ParticleEmitter* New ( ) const
inline

References ParticleEmitter::New().

Referenced by ParticleEmitter::New().

◆ New() [2/2]

ParticleEmitter* New ( ::google::protobuf::Arena *  arena) const

◆ operator=()

ParticleEmitter& operator= ( const ParticleEmitter from)
inline

◆ particle_scatter_ratio()

const ::ignition::msgs::Float & particle_scatter_ratio ( ) const
inline

◆ particle_size()

const ::ignition::msgs::Vector3d & particle_size ( ) const
inline

◆ pose()

const ::ignition::msgs::Pose & pose ( ) const
inline

◆ rate()

const ::ignition::msgs::Float & rate ( ) const
inline

◆ release_color_end()

ignition::msgs::Color * release_color_end ( )
inline

◆ release_color_range_image()

ignition::msgs::StringMsg * release_color_range_image ( )
inline

◆ release_color_start()

ignition::msgs::Color * release_color_start ( )
inline

◆ release_duration()

ignition::msgs::Float * release_duration ( )
inline

◆ release_emitting()

ignition::msgs::Boolean * release_emitting ( )
inline

◆ release_header()

ignition::msgs::Header * release_header ( )
inline

◆ release_lifetime()

ignition::msgs::Float * release_lifetime ( )
inline

◆ release_material()

ignition::msgs::Material * release_material ( )
inline

◆ release_max_velocity()

ignition::msgs::Float * release_max_velocity ( )
inline

◆ release_min_velocity()

ignition::msgs::Float * release_min_velocity ( )
inline

◆ release_name()

std::string * release_name ( )
inline

◆ release_particle_scatter_ratio()

ignition::msgs::Float * release_particle_scatter_ratio ( )
inline

◆ release_particle_size()

ignition::msgs::Vector3d * release_particle_size ( )
inline

◆ release_pose()

ignition::msgs::Pose * release_pose ( )
inline

◆ release_rate()

ignition::msgs::Float * release_rate ( )
inline

◆ release_scale_rate()

ignition::msgs::Float * release_scale_rate ( )
inline

◆ release_size()

ignition::msgs::Vector3d * release_size ( )
inline

◆ release_topic()

ignition::msgs::StringMsg * release_topic ( )
inline

◆ scale_rate()

const ::ignition::msgs::Float & scale_rate ( ) const
inline

◆ SerializeWithCachedSizes()

void SerializeWithCachedSizes ( ::google::protobuf::io::CodedOutputStream *  output) const

◆ SerializeWithCachedSizesToArray()

::google::protobuf::uint8* SerializeWithCachedSizesToArray ( ::google::protobuf::uint8 *  output) const
inline

◆ set_allocated_color_end()

void set_allocated_color_end ( ::ignition::msgs::Color color_end)
inline

◆ set_allocated_color_range_image()

void set_allocated_color_range_image ( ::ignition::msgs::StringMsg color_range_image)
inline

◆ set_allocated_color_start()

void set_allocated_color_start ( ::ignition::msgs::Color color_start)
inline

◆ set_allocated_duration()

void set_allocated_duration ( ::ignition::msgs::Float duration)
inline

◆ set_allocated_emitting()

void set_allocated_emitting ( ::ignition::msgs::Boolean emitting)
inline

◆ set_allocated_header()

void set_allocated_header ( ::ignition::msgs::Header header)
inline

◆ set_allocated_lifetime()

void set_allocated_lifetime ( ::ignition::msgs::Float lifetime)
inline

◆ set_allocated_material()

void set_allocated_material ( ::ignition::msgs::Material material)
inline

◆ set_allocated_max_velocity()

void set_allocated_max_velocity ( ::ignition::msgs::Float max_velocity)
inline

◆ set_allocated_min_velocity()

void set_allocated_min_velocity ( ::ignition::msgs::Float min_velocity)
inline

◆ set_allocated_name()

void set_allocated_name ( ::std::string name)
inline

◆ set_allocated_particle_scatter_ratio()

void set_allocated_particle_scatter_ratio ( ::ignition::msgs::Float particle_scatter_ratio)
inline

◆ set_allocated_particle_size()

void set_allocated_particle_size ( ::ignition::msgs::Vector3d particle_size)
inline

◆ set_allocated_pose()

void set_allocated_pose ( ::ignition::msgs::Pose pose)
inline

◆ set_allocated_rate()

void set_allocated_rate ( ::ignition::msgs::Float rate)
inline

◆ set_allocated_scale_rate()

void set_allocated_scale_rate ( ::ignition::msgs::Float scale_rate)
inline

◆ set_allocated_size()

void set_allocated_size ( ::ignition::msgs::Vector3d size)
inline

◆ set_allocated_topic()

void set_allocated_topic ( ::ignition::msgs::StringMsg topic)
inline

◆ set_id()

void set_id ( ::google::protobuf::uint32  value)
inline

◆ set_name() [1/3]

void set_name ( const ::std::string value)
inline

◆ set_name() [2/3]

void set_name ( const char *  value)
inline

◆ set_name() [3/3]

void set_name ( const char *  value,
size_t  size 
)
inline

◆ set_type()

void set_type ( ::ignition::msgs::ParticleEmitter_EmitterType  value)
inline

◆ size()

const ::ignition::msgs::Vector3d & size ( ) const
inline

◆ Swap()

void Swap ( ParticleEmitter other)

◆ topic()

const ::ignition::msgs::StringMsg & topic ( ) const
inline

◆ type()

Friends And Related Function Documentation

◆ protobuf_AddDesc_ignition_2fmsgs_2fparticle_5femitter_2eproto

void IGNITION_MSGS_VISIBLE protobuf_AddDesc_ignition_2fmsgs_2fparticle_5femitter_2eproto ( )
friend

◆ protobuf_AssignDesc_ignition_2fmsgs_2fparticle_5femitter_2eproto

void protobuf_AssignDesc_ignition_2fmsgs_2fparticle_5femitter_2eproto ( )
friend

◆ protobuf_ShutdownFile_ignition_2fmsgs_2fparticle_5femitter_2eproto

void protobuf_ShutdownFile_ignition_2fmsgs_2fparticle_5femitter_2eproto ( )
friend

Member Data Documentation

◆ BOX

const EmitterType BOX
static

◆ CYLINDER

const EmitterType CYLINDER
static

◆ ELLIPSOID

const EmitterType ELLIPSOID
static

◆ EmitterType_ARRAYSIZE

const int EmitterType_ARRAYSIZE
static

◆ EmitterType_MAX

const EmitterType EmitterType_MAX
static

◆ EmitterType_MIN

const EmitterType EmitterType_MIN
static

◆ kColorEndFieldNumber

const int kColorEndFieldNumber = 16
static

◆ kColorRangeImageFieldNumber

const int kColorRangeImageFieldNumber = 18
static

◆ kColorStartFieldNumber

const int kColorStartFieldNumber = 15
static

◆ kDurationFieldNumber

const int kDurationFieldNumber = 8
static

◆ kEmittingFieldNumber

const int kEmittingFieldNumber = 9
static

◆ kHeaderFieldNumber

const int kHeaderFieldNumber = 1
static

◆ kIdFieldNumber

const int kIdFieldNumber = 3
static

◆ kLifetimeFieldNumber

const int kLifetimeFieldNumber = 11
static

◆ kMaterialFieldNumber

const int kMaterialFieldNumber = 12
static

◆ kMaxVelocityFieldNumber

const int kMaxVelocityFieldNumber = 14
static

◆ kMinVelocityFieldNumber

const int kMinVelocityFieldNumber = 13
static

◆ kNameFieldNumber

const int kNameFieldNumber = 2
static

◆ kParticleScatterRatioFieldNumber

const int kParticleScatterRatioFieldNumber = 20
static

◆ kParticleSizeFieldNumber

const int kParticleSizeFieldNumber = 10
static

◆ kPoseFieldNumber

const int kPoseFieldNumber = 5
static

◆ kRateFieldNumber

const int kRateFieldNumber = 7
static

◆ kScaleRateFieldNumber

const int kScaleRateFieldNumber = 17
static

◆ kSizeFieldNumber

const int kSizeFieldNumber = 6
static

◆ kTopicFieldNumber

const int kTopicFieldNumber = 19
static

◆ kTypeFieldNumber

const int kTypeFieldNumber = 4
static

◆ POINT

const EmitterType POINT
static

The documentation for this class was generated from the following file: