Ignition Msgs

API Reference

5.8.1

#include <light.pb.h>

Public Types

enum  : int {
  kNameFieldNumber = 2 , kHeaderFieldNumber = 1 , kPoseFieldNumber = 4 , kDiffuseFieldNumber = 5 ,
  kSpecularFieldNumber = 6 , kDirectionFieldNumber = 10 , kTypeFieldNumber = 3 , kAttenuationConstantFieldNumber = 7 ,
  kAttenuationLinearFieldNumber = 8 , kAttenuationQuadraticFieldNumber = 9 , kRangeFieldNumber = 11 , kCastShadowsFieldNumber = 12 ,
  kSpotInnerAngleFieldNumber = 13 , kSpotOuterAngleFieldNumber = 14 , kSpotFalloffFieldNumber = 15 , kIdFieldNumber = 16 ,
  kParentIdFieldNumber = 17
}
 
typedef Light_LightType LightType
 

Public Member Functions

 Light ()
 
constexpr Light (::PROTOBUF_NAMESPACE_ID::internal::ConstantInitialized)
 
 Light (const Light &from)
 
 Light (Light &&from) noexcept
 
 ~Light () override
 
const char * _InternalParse (const char *ptr, ::PROTOBUF_NAMESPACE_ID::internal::ParseContext *ctx) final
 
uint8_t * _InternalSerialize (uint8_t *target, ::PROTOBUF_NAMESPACE_ID::io::EpsCopyOutputStream *stream) const final
 
float attenuation_constant () const
 
float attenuation_linear () const
 
float attenuation_quadratic () const
 
size_t ByteSizeLong () const final
 
bool cast_shadows () const
 
PROTOBUF_ATTRIBUTE_REINITIALIZES void Clear () final
 
void clear_attenuation_constant ()
 
void clear_attenuation_linear ()
 
void clear_attenuation_quadratic ()
 
void clear_cast_shadows ()
 
void clear_diffuse ()
 
void clear_direction ()
 
void clear_header ()
 
void clear_id ()
 
void clear_name ()
 
void clear_parent_id ()
 
void clear_pose ()
 
void clear_range ()
 
void clear_specular ()
 
void clear_spot_falloff ()
 
void clear_spot_inner_angle ()
 
void clear_spot_outer_angle ()
 
void clear_type ()
 
void CopyFrom (const Light &from)
 
const ::ignition::msgs::Colordiffuse () const
 
const ::ignition::msgs::Vector3ddirection () const
 
int GetCachedSize () const final
 
const ::PROTOBUF_NAMESPACE_ID::Message::ClassData * GetClassData () const final
 
::PROTOBUF_NAMESPACE_ID::Metadata GetMetadata () const final
 
bool has_diffuse () const
 
bool has_direction () const
 
bool has_header () const
 
bool has_pose () const
 
bool has_specular () const
 
const ::ignition::msgs::Headerheader () const
 
uint32_t id () const
 
bool IsInitialized () const final
 
void MergeFrom (const Light &from)
 
::ignition::msgs::Colormutable_diffuse ()
 
::ignition::msgs::Vector3dmutable_direction ()
 
::ignition::msgs::Headermutable_header ()
 
std::stringmutable_name ()
 
::ignition::msgs::Posemutable_pose ()
 
::ignition::msgs::Colormutable_specular ()
 
const std::stringname () const
 
LightNew (::PROTOBUF_NAMESPACE_ID::Arena *arena=nullptr) const final
 
Lightoperator= (const Light &from)
 
Lightoperator= (Light &&from) noexcept
 
uint32_t parent_id () const
 
const ::ignition::msgs::Posepose () const
 
float range () const
 
PROTOBUF_NODISCARD ::ignition::msgs::Colorrelease_diffuse ()
 
PROTOBUF_NODISCARD ::ignition::msgs::Vector3drelease_direction ()
 
PROTOBUF_NODISCARD ::ignition::msgs::Headerrelease_header ()
 
PROTOBUF_NODISCARD std::stringrelease_name ()
 
PROTOBUF_NODISCARD ::ignition::msgs::Poserelease_pose ()
 
PROTOBUF_NODISCARD ::ignition::msgs::Colorrelease_specular ()
 
void set_allocated_diffuse (::ignition::msgs::Color *diffuse)
 
void set_allocated_direction (::ignition::msgs::Vector3d *direction)
 
void set_allocated_header (::ignition::msgs::Header *header)
 
void set_allocated_name (std::string *name)
 
void set_allocated_pose (::ignition::msgs::Pose *pose)
 
void set_allocated_specular (::ignition::msgs::Color *specular)
 
void set_attenuation_constant (float value)
 
void set_attenuation_linear (float value)
 
void set_attenuation_quadratic (float value)
 
void set_cast_shadows (bool value)
 
void set_id (uint32_t value)
 
template<typename ArgT0 = const std::string&, typename... ArgT>
void set_name (ArgT0 &&arg0, ArgT... args)
 
template<typename ArgT0 , typename... ArgT>
PROTOBUF_ALWAYS_INLINE void set_name (ArgT0 &&arg0, ArgT... args)
 
void set_parent_id (uint32_t value)
 
void set_range (float value)
 
void set_spot_falloff (float value)
 
void set_spot_inner_angle (float value)
 
void set_spot_outer_angle (float value)
 
void set_type (::ignition::msgs::Light_LightType value)
 
const ::ignition::msgs::Colorspecular () const
 
float spot_falloff () const
 
float spot_inner_angle () const
 
float spot_outer_angle () const
 
void Swap (Light *other)
 
::ignition::msgs::Light_LightType type () const
 
::ignition::msgs::Colorunsafe_arena_release_diffuse ()
 
::ignition::msgs::Vector3dunsafe_arena_release_direction ()
 
::ignition::msgs::Headerunsafe_arena_release_header ()
 
::ignition::msgs::Poseunsafe_arena_release_pose ()
 
::ignition::msgs::Colorunsafe_arena_release_specular ()
 
void unsafe_arena_set_allocated_diffuse (::ignition::msgs::Color *diffuse)
 
void unsafe_arena_set_allocated_direction (::ignition::msgs::Vector3d *direction)
 
void unsafe_arena_set_allocated_header (::ignition::msgs::Header *header)
 
void unsafe_arena_set_allocated_pose (::ignition::msgs::Pose *pose)
 
void unsafe_arena_set_allocated_specular (::ignition::msgs::Color *specular)
 
void UnsafeArenaSwap (Light *other)
 

Static Public Member Functions

static const Lightdefault_instance ()
 
static const ::PROTOBUF_NAMESPACE_ID::Descriptor * descriptor ()
 
static const ::PROTOBUF_NAMESPACE_ID::Descriptor * GetDescriptor ()
 
static const ::PROTOBUF_NAMESPACE_ID::Reflection * GetReflection ()
 
static const Lightinternal_default_instance ()
 
static const ::PROTOBUF_NAMESPACE_ID::EnumDescriptor * LightType_descriptor ()
 
static bool LightType_IsValid (int value)
 
template<typename T >
static const std::stringLightType_Name (T enum_t_value)
 
static bool LightType_Parse (::PROTOBUF_NAMESPACE_ID::ConstStringParam name, LightType *value)
 

Static Public Attributes

static const ClassData _class_data_
 
static constexpr LightType DIRECTIONAL
 
static constexpr int kIndexInFileMessages
 
static constexpr int LightType_ARRAYSIZE
 
static constexpr LightType LightType_MAX
 
static constexpr LightType LightType_MIN
 
static constexpr LightType POINT
 
static constexpr LightType SPOT
 

Protected Member Functions

 Light (::PROTOBUF_NAMESPACE_ID::Arena *arena, bool is_message_owned=false)
 

Member Typedef Documentation

◆ LightType

Member Enumeration Documentation

◆ anonymous enum

anonymous enum : int
Enumerator
kNameFieldNumber 
kHeaderFieldNumber 
kPoseFieldNumber 
kDiffuseFieldNumber 
kSpecularFieldNumber 
kDirectionFieldNumber 
kTypeFieldNumber 
kAttenuationConstantFieldNumber 
kAttenuationLinearFieldNumber 
kAttenuationQuadraticFieldNumber 
kRangeFieldNumber 
kCastShadowsFieldNumber 
kSpotInnerAngleFieldNumber 
kSpotOuterAngleFieldNumber 
kSpotFalloffFieldNumber 
kIdFieldNumber 
kParentIdFieldNumber 

Constructor & Destructor Documentation

◆ Light() [1/5]

Light ( )
inline

◆ ~Light()

~Light ( )
override

◆ Light() [2/5]

constexpr Light ( ::PROTOBUF_NAMESPACE_ID::internal::ConstantInitialized  )
explicitconstexpr

◆ Light() [3/5]

Light ( const Light from)

◆ Light() [4/5]

Light ( Light &&  from)
inlinenoexcept

◆ Light() [5/5]

Light ( ::PROTOBUF_NAMESPACE_ID::Arena *  arena,
bool  is_message_owned = false 
)
explicitprotected

Member Function Documentation

◆ _InternalParse()

const char* _InternalParse ( const char *  ptr,
::PROTOBUF_NAMESPACE_ID::internal::ParseContext *  ctx 
)
final

◆ _InternalSerialize()

uint8_t* _InternalSerialize ( uint8_t *  target,
::PROTOBUF_NAMESPACE_ID::io::EpsCopyOutputStream *  stream 
) const
final

◆ attenuation_constant()

float attenuation_constant ( ) const
inline

◆ attenuation_linear()

float attenuation_linear ( ) const
inline

◆ attenuation_quadratic()

float attenuation_quadratic ( ) const
inline

◆ ByteSizeLong()

size_t ByteSizeLong ( ) const
final

◆ cast_shadows()

bool cast_shadows ( ) const
inline

◆ Clear()

PROTOBUF_ATTRIBUTE_REINITIALIZES void Clear ( )
final

◆ clear_attenuation_constant()

void clear_attenuation_constant ( )
inline

◆ clear_attenuation_linear()

void clear_attenuation_linear ( )
inline

◆ clear_attenuation_quadratic()

void clear_attenuation_quadratic ( )
inline

◆ clear_cast_shadows()

void clear_cast_shadows ( )
inline

◆ clear_diffuse()

void clear_diffuse ( )

◆ clear_direction()

void clear_direction ( )

◆ clear_header()

void clear_header ( )

◆ clear_id()

void clear_id ( )
inline

◆ clear_name()

void clear_name ( )
inline

◆ clear_parent_id()

void clear_parent_id ( )
inline

◆ clear_pose()

void clear_pose ( )

◆ clear_range()

void clear_range ( )
inline

◆ clear_specular()

void clear_specular ( )

◆ clear_spot_falloff()

void clear_spot_falloff ( )
inline

◆ clear_spot_inner_angle()

void clear_spot_inner_angle ( )
inline

◆ clear_spot_outer_angle()

void clear_spot_outer_angle ( )
inline

◆ clear_type()

void clear_type ( )
inline

◆ CopyFrom()

void CopyFrom ( const Light from)

◆ default_instance()

static const Light& default_instance ( )
inlinestatic

◆ descriptor()

static const ::PROTOBUF_NAMESPACE_ID::Descriptor* descriptor ( )
inlinestatic

◆ diffuse()

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

◆ direction()

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

◆ GetCachedSize()

int GetCachedSize ( ) const
inlinefinal

◆ GetClassData()

const ::PROTOBUF_NAMESPACE_ID::Message::ClassData* GetClassData ( ) const
final

◆ GetDescriptor()

static const ::PROTOBUF_NAMESPACE_ID::Descriptor* GetDescriptor ( )
inlinestatic

◆ GetMetadata()

::PROTOBUF_NAMESPACE_ID::Metadata GetMetadata ( ) const
final

◆ GetReflection()

static const ::PROTOBUF_NAMESPACE_ID::Reflection* GetReflection ( )
inlinestatic

◆ has_diffuse()

bool has_diffuse ( ) const
inline

◆ has_direction()

bool has_direction ( ) const
inline

◆ has_header()

bool has_header ( ) const
inline

◆ has_pose()

bool has_pose ( ) const
inline

◆ has_specular()

bool has_specular ( ) const
inline

◆ header()

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

◆ id()

uint32_t id ( ) const
inline

◆ internal_default_instance()

static const Light* internal_default_instance ( )
inlinestatic

◆ IsInitialized()

bool IsInitialized ( ) const
final

◆ LightType_descriptor()

static const ::PROTOBUF_NAMESPACE_ID::EnumDescriptor* LightType_descriptor ( )
inlinestatic

◆ LightType_IsValid()

static bool LightType_IsValid ( int  value)
inlinestatic

◆ LightType_Name()

static const std::string& LightType_Name ( enum_t_value)
inlinestatic

◆ LightType_Parse()

static bool LightType_Parse ( ::PROTOBUF_NAMESPACE_ID::ConstStringParam  name,
LightType value 
)
inlinestatic

◆ MergeFrom()

void MergeFrom ( const Light from)

◆ mutable_diffuse()

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

◆ mutable_direction()

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

◆ mutable_header()

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

◆ mutable_name()

std::string * mutable_name ( )
inline

◆ mutable_pose()

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

◆ mutable_specular()

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

◆ name()

const std::string & name ( ) const
inline

◆ New()

Light* New ( ::PROTOBUF_NAMESPACE_ID::Arena *  arena = nullptr) const
inlinefinal

◆ operator=() [1/2]

Light& operator= ( const Light from)
inline

◆ operator=() [2/2]

Light& operator= ( Light &&  from)
inlinenoexcept

◆ parent_id()

uint32_t parent_id ( ) const
inline

◆ pose()

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

◆ range()

float range ( ) const
inline

◆ release_diffuse()

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

◆ release_direction()

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

◆ release_header()

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

◆ release_name()

std::string * release_name ( )
inline

◆ release_pose()

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

◆ release_specular()

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

◆ set_allocated_diffuse()

void set_allocated_diffuse ( ::ignition::msgs::Color diffuse)
inline

◆ set_allocated_direction()

void set_allocated_direction ( ::ignition::msgs::Vector3d direction)
inline

◆ set_allocated_header()

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

◆ set_allocated_name()

void set_allocated_name ( std::string name)
inline

◆ set_allocated_pose()

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

◆ set_allocated_specular()

void set_allocated_specular ( ::ignition::msgs::Color specular)
inline

◆ set_attenuation_constant()

void set_attenuation_constant ( float  value)
inline

◆ set_attenuation_linear()

void set_attenuation_linear ( float  value)
inline

◆ set_attenuation_quadratic()

void set_attenuation_quadratic ( float  value)
inline

◆ set_cast_shadows()

void set_cast_shadows ( bool  value)
inline

◆ set_id()

void set_id ( uint32_t  value)
inline

◆ set_name() [1/2]

void set_name ( ArgT0 &&  arg0,
ArgT...  args 
)

◆ set_name() [2/2]

PROTOBUF_ALWAYS_INLINE void set_name ( ArgT0 &&  arg0,
ArgT...  args 
)
inline

◆ set_parent_id()

void set_parent_id ( uint32_t  value)
inline

◆ set_range()

void set_range ( float  value)
inline

◆ set_spot_falloff()

void set_spot_falloff ( float  value)
inline

◆ set_spot_inner_angle()

void set_spot_inner_angle ( float  value)
inline

◆ set_spot_outer_angle()

void set_spot_outer_angle ( float  value)
inline

◆ set_type()

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

◆ specular()

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

◆ spot_falloff()

float spot_falloff ( ) const
inline

◆ spot_inner_angle()

float spot_inner_angle ( ) const
inline

◆ spot_outer_angle()

float spot_outer_angle ( ) const
inline

◆ Swap()

void Swap ( Light other)
inline

◆ type()

ignition::msgs::Light_LightType type ( ) const
inline

◆ unsafe_arena_release_diffuse()

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

◆ unsafe_arena_release_direction()

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

◆ unsafe_arena_release_header()

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

◆ unsafe_arena_release_pose()

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

◆ unsafe_arena_release_specular()

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

◆ unsafe_arena_set_allocated_diffuse()

void unsafe_arena_set_allocated_diffuse ( ::ignition::msgs::Color diffuse)
inline

◆ unsafe_arena_set_allocated_direction()

void unsafe_arena_set_allocated_direction ( ::ignition::msgs::Vector3d direction)
inline

◆ unsafe_arena_set_allocated_header()

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

◆ unsafe_arena_set_allocated_pose()

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

◆ unsafe_arena_set_allocated_specular()

void unsafe_arena_set_allocated_specular ( ::ignition::msgs::Color specular)
inline

◆ UnsafeArenaSwap()

void UnsafeArenaSwap ( Light other)
inline

Member Data Documentation

◆ _class_data_

const ClassData _class_data_
static

◆ DIRECTIONAL

constexpr LightType DIRECTIONAL
staticconstexpr
Initial value:
=
@ Light_LightType_DIRECTIONAL
Definition: light.pb.h:88

◆ kIndexInFileMessages

constexpr int kIndexInFileMessages
staticconstexpr
Initial value:
=
0

◆ LightType_ARRAYSIZE

constexpr int LightType_ARRAYSIZE
staticconstexpr
Initial value:
=
constexpr int Light_LightType_LightType_ARRAYSIZE
Definition: light.pb.h:95

◆ LightType_MAX

constexpr LightType LightType_MAX
staticconstexpr
Initial value:
=
constexpr Light_LightType Light_LightType_LightType_MAX
Definition: light.pb.h:94

◆ LightType_MIN

constexpr LightType LightType_MIN
staticconstexpr
Initial value:
=
constexpr Light_LightType Light_LightType_LightType_MIN
Definition: light.pb.h:93

◆ POINT

constexpr LightType POINT
staticconstexpr
Initial value:
=
@ Light_LightType_POINT
Definition: light.pb.h:86

◆ SPOT

constexpr LightType SPOT
staticconstexpr
Initial value:
=
@ Light_LightType_SPOT
Definition: light.pb.h:87

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