Ignition Msgs

API Reference

5.8.1

#include <visual.pb.h>

Public Types

enum  : int {
  kPluginFieldNumber = 15 , kNameFieldNumber = 2 , kParentNameFieldNumber = 4 , kHeaderFieldNumber = 1 ,
  kPoseFieldNumber = 9 , kGeometryFieldNumber = 10 , kMaterialFieldNumber = 11 , kScaleFieldNumber = 16 ,
  kMetaFieldNumber = 17 , kIdFieldNumber = 3 , kParentIdFieldNumber = 5 , kTransparencyFieldNumber = 7 ,
  kLaserRetroFieldNumber = 8 , kCastShadowsFieldNumber = 6 , kVisibleFieldNumber = 12 , kDeleteMeFieldNumber = 13 ,
  kIsStaticFieldNumber = 14 , kTypeFieldNumber = 18
}
 
typedef Visual_Meta Meta
 
typedef Visual_Type Type
 

Public Member Functions

 Visual ()
 
constexpr Visual (::PROTOBUF_NAMESPACE_ID::internal::ConstantInitialized)
 
 Visual (const Visual &from)
 
 Visual (Visual &&from) noexcept
 
 ~Visual () 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
 
::ignition::msgs::Pluginadd_plugin ()
 
size_t ByteSizeLong () const final
 
bool cast_shadows () const
 
PROTOBUF_ATTRIBUTE_REINITIALIZES void Clear () final
 
void clear_cast_shadows ()
 
void clear_delete_me ()
 
void clear_geometry ()
 
void clear_header ()
 
void clear_id ()
 
void clear_is_static ()
 
void clear_laser_retro ()
 
void clear_material ()
 
void clear_meta ()
 
void clear_name ()
 
void clear_parent_id ()
 
void clear_parent_name ()
 
void clear_plugin ()
 
void clear_pose ()
 
void clear_scale ()
 
void clear_transparency ()
 
void clear_type ()
 
void clear_visible ()
 
void CopyFrom (const Visual &from)
 
bool delete_me () const
 
const ::ignition::msgs::Geometrygeometry () const
 
int GetCachedSize () const final
 
const ::PROTOBUF_NAMESPACE_ID::Message::ClassData * GetClassData () const final
 
::PROTOBUF_NAMESPACE_ID::Metadata GetMetadata () const final
 
bool has_geometry () const
 
bool has_header () const
 
bool has_material () const
 
bool has_meta () const
 
bool has_pose () const
 
bool has_scale () const
 
const ::ignition::msgs::Headerheader () const
 
uint32_t id () const
 
bool is_static () const
 
bool IsInitialized () const final
 
double laser_retro () const
 
const ::ignition::msgs::Materialmaterial () const
 
void MergeFrom (const Visual &from)
 
const ::ignition::msgs::Visual_Metameta () const
 
::ignition::msgs::Geometrymutable_geometry ()
 
::ignition::msgs::Headermutable_header ()
 
::ignition::msgs::Materialmutable_material ()
 
::ignition::msgs::Visual_Metamutable_meta ()
 
std::stringmutable_name ()
 
std::stringmutable_parent_name ()
 
::PROTOBUF_NAMESPACE_ID::RepeatedPtrField< ::ignition::msgs::Plugin > * mutable_plugin ()
 
::ignition::msgs::Pluginmutable_plugin (int index)
 
::ignition::msgs::Posemutable_pose ()
 
::ignition::msgs::Vector3dmutable_scale ()
 
const std::stringname () const
 
VisualNew (::PROTOBUF_NAMESPACE_ID::Arena *arena=nullptr) const final
 
Visualoperator= (const Visual &from)
 
Visualoperator= (Visual &&from) noexcept
 
uint32_t parent_id () const
 
const std::stringparent_name () const
 
const ::PROTOBUF_NAMESPACE_ID::RepeatedPtrField< ::ignition::msgs::Plugin > & plugin () const
 
const ::ignition::msgs::Pluginplugin (int index) const
 
int plugin_size () const
 
const ::ignition::msgs::Posepose () const
 
PROTOBUF_NODISCARD ::ignition::msgs::Geometryrelease_geometry ()
 
PROTOBUF_NODISCARD ::ignition::msgs::Headerrelease_header ()
 
PROTOBUF_NODISCARD ::ignition::msgs::Materialrelease_material ()
 
PROTOBUF_NODISCARD ::ignition::msgs::Visual_Metarelease_meta ()
 
PROTOBUF_NODISCARD std::stringrelease_name ()
 
PROTOBUF_NODISCARD std::stringrelease_parent_name ()
 
PROTOBUF_NODISCARD ::ignition::msgs::Poserelease_pose ()
 
PROTOBUF_NODISCARD ::ignition::msgs::Vector3drelease_scale ()
 
const ::ignition::msgs::Vector3dscale () const
 
void set_allocated_geometry (::ignition::msgs::Geometry *geometry)
 
void set_allocated_header (::ignition::msgs::Header *header)
 
void set_allocated_material (::ignition::msgs::Material *material)
 
void set_allocated_meta (::ignition::msgs::Visual_Meta *meta)
 
void set_allocated_name (std::string *name)
 
void set_allocated_parent_name (std::string *parent_name)
 
void set_allocated_pose (::ignition::msgs::Pose *pose)
 
void set_allocated_scale (::ignition::msgs::Vector3d *scale)
 
void set_cast_shadows (bool value)
 
void set_delete_me (bool value)
 
void set_id (uint32_t value)
 
void set_is_static (bool value)
 
void set_laser_retro (double 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)
 
template<typename ArgT0 = const std::string&, typename... ArgT>
void set_parent_name (ArgT0 &&arg0, ArgT... args)
 
template<typename ArgT0 , typename... ArgT>
PROTOBUF_ALWAYS_INLINE void set_parent_name (ArgT0 &&arg0, ArgT... args)
 
void set_transparency (double value)
 
void set_type (::ignition::msgs::Visual_Type value)
 
void set_visible (bool value)
 
void Swap (Visual *other)
 
double transparency () const
 
::ignition::msgs::Visual_Type type () const
 
::ignition::msgs::Geometryunsafe_arena_release_geometry ()
 
::ignition::msgs::Headerunsafe_arena_release_header ()
 
::ignition::msgs::Materialunsafe_arena_release_material ()
 
::ignition::msgs::Visual_Metaunsafe_arena_release_meta ()
 
::ignition::msgs::Poseunsafe_arena_release_pose ()
 
::ignition::msgs::Vector3dunsafe_arena_release_scale ()
 
void unsafe_arena_set_allocated_geometry (::ignition::msgs::Geometry *geometry)
 
void unsafe_arena_set_allocated_header (::ignition::msgs::Header *header)
 
void unsafe_arena_set_allocated_material (::ignition::msgs::Material *material)
 
void unsafe_arena_set_allocated_meta (::ignition::msgs::Visual_Meta *meta)
 
void unsafe_arena_set_allocated_pose (::ignition::msgs::Pose *pose)
 
void unsafe_arena_set_allocated_scale (::ignition::msgs::Vector3d *scale)
 
void UnsafeArenaSwap (Visual *other)
 
bool visible () const
 

Static Public Member Functions

static const Visualdefault_instance ()
 
static const ::PROTOBUF_NAMESPACE_ID::Descriptor * descriptor ()
 
static const ::PROTOBUF_NAMESPACE_ID::Descriptor * GetDescriptor ()
 
static const ::PROTOBUF_NAMESPACE_ID::Reflection * GetReflection ()
 
static const Visualinternal_default_instance ()
 
static const ::PROTOBUF_NAMESPACE_ID::EnumDescriptor * Type_descriptor ()
 
static bool Type_IsValid (int value)
 
template<typename T >
static const std::stringType_Name (T enum_t_value)
 
static bool Type_Parse (::PROTOBUF_NAMESPACE_ID::ConstStringParam name, Type *value)
 

Static Public Attributes

static const ClassData _class_data_
 
static constexpr Type COLLISION
 
static constexpr Type ENTITY
 
static constexpr Type GUI
 
static constexpr int kIndexInFileMessages
 
static constexpr Type LINK
 
static constexpr Type MODEL
 
static constexpr Type PHYSICS
 
static constexpr Type SENSOR
 
static constexpr int Type_ARRAYSIZE
 
static constexpr Type Type_MAX
 
static constexpr Type Type_MIN
 
static constexpr Type VISUAL
 

Protected Member Functions

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

Member Typedef Documentation

◆ Meta

typedef Visual_Meta Meta

◆ Type

typedef Visual_Type Type

Member Enumeration Documentation

◆ anonymous enum

anonymous enum : int
Enumerator
kPluginFieldNumber 
kNameFieldNumber 
kParentNameFieldNumber 
kHeaderFieldNumber 
kPoseFieldNumber 
kGeometryFieldNumber 
kMaterialFieldNumber 
kScaleFieldNumber 
kMetaFieldNumber 
kIdFieldNumber 
kParentIdFieldNumber 
kTransparencyFieldNumber 
kLaserRetroFieldNumber 
kCastShadowsFieldNumber 
kVisibleFieldNumber 
kDeleteMeFieldNumber 
kIsStaticFieldNumber 
kTypeFieldNumber 

Constructor & Destructor Documentation

◆ Visual() [1/5]

Visual ( )
inline

◆ ~Visual()

~Visual ( )
override

◆ Visual() [2/5]

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

◆ Visual() [3/5]

Visual ( const Visual from)

◆ Visual() [4/5]

Visual ( Visual &&  from)
inlinenoexcept

◆ Visual() [5/5]

Visual ( ::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

◆ add_plugin()

ignition::msgs::Plugin * add_plugin ( )
inline

◆ ByteSizeLong()

size_t ByteSizeLong ( ) const
final

◆ cast_shadows()

bool cast_shadows ( ) const
inline

◆ Clear()

PROTOBUF_ATTRIBUTE_REINITIALIZES void Clear ( )
final

◆ clear_cast_shadows()

void clear_cast_shadows ( )
inline

◆ clear_delete_me()

void clear_delete_me ( )
inline

◆ clear_geometry()

void clear_geometry ( )

◆ clear_header()

void clear_header ( )

◆ clear_id()

void clear_id ( )
inline

◆ clear_is_static()

void clear_is_static ( )
inline

◆ clear_laser_retro()

void clear_laser_retro ( )
inline

◆ clear_material()

void clear_material ( )

◆ clear_meta()

void clear_meta ( )
inline

◆ clear_name()

void clear_name ( )
inline

◆ clear_parent_id()

void clear_parent_id ( )
inline

◆ clear_parent_name()

void clear_parent_name ( )
inline

◆ clear_plugin()

void clear_plugin ( )

◆ clear_pose()

void clear_pose ( )

◆ clear_scale()

void clear_scale ( )

◆ clear_transparency()

void clear_transparency ( )
inline

◆ clear_type()

void clear_type ( )
inline

◆ clear_visible()

void clear_visible ( )
inline

◆ CopyFrom()

void CopyFrom ( const Visual from)

◆ default_instance()

static const Visual& default_instance ( )
inlinestatic

◆ delete_me()

bool delete_me ( ) const
inline

◆ descriptor()

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

◆ geometry()

const ::ignition::msgs::Geometry & geometry ( ) 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_geometry()

bool has_geometry ( ) const
inline

◆ has_header()

bool has_header ( ) const
inline

◆ has_material()

bool has_material ( ) const
inline

◆ has_meta()

bool has_meta ( ) const
inline

◆ has_pose()

bool has_pose ( ) const
inline

◆ has_scale()

bool has_scale ( ) const
inline

◆ header()

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

◆ id()

uint32_t id ( ) const
inline

◆ internal_default_instance()

static const Visual* internal_default_instance ( )
inlinestatic

◆ is_static()

bool is_static ( ) const
inline

◆ IsInitialized()

bool IsInitialized ( ) const
final

◆ laser_retro()

double laser_retro ( ) const
inline

◆ material()

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

◆ MergeFrom()

void MergeFrom ( const Visual from)

◆ meta()

const ::ignition::msgs::Visual_Meta & meta ( ) const
inline

◆ mutable_geometry()

ignition::msgs::Geometry * mutable_geometry ( )
inline

◆ mutable_header()

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

◆ mutable_material()

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

◆ mutable_meta()

ignition::msgs::Visual_Meta * mutable_meta ( )
inline

◆ mutable_name()

std::string * mutable_name ( )
inline

◆ mutable_parent_name()

std::string * mutable_parent_name ( )
inline

◆ mutable_plugin() [1/2]

PROTOBUF_NAMESPACE_ID::RepeatedPtrField<::ignition::msgs::Plugin > * mutable_plugin ( )
inline

◆ mutable_plugin() [2/2]

ignition::msgs::Plugin * mutable_plugin ( int  index)
inline

◆ mutable_pose()

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

◆ mutable_scale()

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

◆ name()

const std::string & name ( ) const
inline

◆ New()

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

◆ operator=() [1/2]

Visual& operator= ( const Visual from)
inline

◆ operator=() [2/2]

Visual& operator= ( Visual &&  from)
inlinenoexcept

◆ parent_id()

uint32_t parent_id ( ) const
inline

◆ parent_name()

const std::string & parent_name ( ) const
inline

◆ plugin() [1/2]

const ::PROTOBUF_NAMESPACE_ID::RepeatedPtrField<::ignition::msgs::Plugin > & plugin ( ) const
inline

◆ plugin() [2/2]

const ::ignition::msgs::Plugin & plugin ( int  index) const
inline

◆ plugin_size()

int plugin_size ( ) const
inline

◆ pose()

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

◆ release_geometry()

ignition::msgs::Geometry * release_geometry ( )
inline

◆ release_header()

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

◆ release_material()

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

◆ release_meta()

ignition::msgs::Visual_Meta * release_meta ( )
inline

◆ release_name()

std::string * release_name ( )
inline

◆ release_parent_name()

std::string * release_parent_name ( )
inline

◆ release_pose()

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

◆ release_scale()

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

◆ scale()

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

◆ set_allocated_geometry()

void set_allocated_geometry ( ::ignition::msgs::Geometry geometry)
inline

◆ set_allocated_header()

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

◆ set_allocated_material()

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

◆ set_allocated_meta()

void set_allocated_meta ( ::ignition::msgs::Visual_Meta meta)
inline

◆ set_allocated_name()

void set_allocated_name ( std::string name)
inline

◆ set_allocated_parent_name()

void set_allocated_parent_name ( std::string parent_name)
inline

◆ set_allocated_pose()

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

◆ set_allocated_scale()

void set_allocated_scale ( ::ignition::msgs::Vector3d scale)
inline

◆ set_cast_shadows()

void set_cast_shadows ( bool  value)
inline

◆ set_delete_me()

void set_delete_me ( bool  value)
inline

◆ set_id()

void set_id ( uint32_t  value)
inline

◆ set_is_static()

void set_is_static ( bool  value)
inline

◆ set_laser_retro()

void set_laser_retro ( double  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_parent_name() [1/2]

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

◆ set_parent_name() [2/2]

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

◆ set_transparency()

void set_transparency ( double  value)
inline

◆ set_type()

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

◆ set_visible()

void set_visible ( bool  value)
inline

◆ Swap()

void Swap ( Visual other)
inline

◆ transparency()

double transparency ( ) const
inline

◆ type()

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

◆ Type_descriptor()

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

◆ Type_IsValid()

static bool Type_IsValid ( int  value)
inlinestatic

◆ Type_Name()

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

◆ Type_Parse()

static bool Type_Parse ( ::PROTOBUF_NAMESPACE_ID::ConstStringParam  name,
Type value 
)
inlinestatic

◆ unsafe_arena_release_geometry()

ignition::msgs::Geometry * unsafe_arena_release_geometry ( )
inline

◆ unsafe_arena_release_header()

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

◆ unsafe_arena_release_material()

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

◆ unsafe_arena_release_meta()

ignition::msgs::Visual_Meta * unsafe_arena_release_meta ( )
inline

◆ unsafe_arena_release_pose()

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

◆ unsafe_arena_release_scale()

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

◆ unsafe_arena_set_allocated_geometry()

void unsafe_arena_set_allocated_geometry ( ::ignition::msgs::Geometry geometry)
inline

◆ unsafe_arena_set_allocated_header()

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

◆ unsafe_arena_set_allocated_material()

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

◆ unsafe_arena_set_allocated_meta()

void unsafe_arena_set_allocated_meta ( ::ignition::msgs::Visual_Meta meta)
inline

◆ unsafe_arena_set_allocated_pose()

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

◆ unsafe_arena_set_allocated_scale()

void unsafe_arena_set_allocated_scale ( ::ignition::msgs::Vector3d scale)
inline

◆ UnsafeArenaSwap()

void UnsafeArenaSwap ( Visual other)
inline

◆ visible()

bool visible ( ) const
inline

Member Data Documentation

◆ _class_data_

const ClassData _class_data_
static

◆ COLLISION

constexpr Type COLLISION
staticconstexpr
Initial value:
=
@ Visual_Type_COLLISION
Definition: visual.pb.h:96

◆ ENTITY

constexpr Type ENTITY
staticconstexpr
Initial value:
=
@ Visual_Type_ENTITY
Definition: visual.pb.h:92

◆ GUI

constexpr Type GUI
staticconstexpr
Initial value:
=
@ Visual_Type_GUI
Definition: visual.pb.h:98

◆ kIndexInFileMessages

constexpr int kIndexInFileMessages
staticconstexpr
Initial value:
=
1

◆ LINK

constexpr Type LINK
staticconstexpr
Initial value:
=
@ Visual_Type_LINK
Definition: visual.pb.h:94

◆ MODEL

constexpr Type MODEL
staticconstexpr
Initial value:
=
@ Visual_Type_MODEL
Definition: visual.pb.h:93

◆ PHYSICS

constexpr Type PHYSICS
staticconstexpr
Initial value:
=
@ Visual_Type_PHYSICS
Definition: visual.pb.h:99

◆ SENSOR

constexpr Type SENSOR
staticconstexpr
Initial value:
=
@ Visual_Type_SENSOR
Definition: visual.pb.h:97

◆ Type_ARRAYSIZE

constexpr int Type_ARRAYSIZE
staticconstexpr
Initial value:
=
constexpr int Visual_Type_Type_ARRAYSIZE
Definition: visual.pb.h:106

◆ Type_MAX

constexpr Type Type_MAX
staticconstexpr
Initial value:
=
constexpr Visual_Type Visual_Type_Type_MAX
Definition: visual.pb.h:105

◆ Type_MIN

constexpr Type Type_MIN
staticconstexpr
Initial value:
=
constexpr Visual_Type Visual_Type_Type_MIN
Definition: visual.pb.h:104

◆ VISUAL

constexpr Type VISUAL
staticconstexpr
Initial value:
=
@ Visual_Type_VISUAL
Definition: visual.pb.h:95

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