vsg::Object Class Reference

Inherited by vsg::Inherit< Object, TileDatabaseSettings >, vsg::Inherit< Object, RayTracingShaderGroup >, vsg::Inherit< Object, MemoryBarrier >, vsg::Inherit< Object, DeviceExtensions >, vsg::Inherit< Object, Node >, vsg::Inherit< Object, ImageView >, vsg::Inherit< Object, ImageMemoryBarrier >, vsg::Inherit< Object, Framebuffer >, vsg::Inherit< Object, DatabaseQueue >, vsg::Inherit< Object, CustomDescriptorSetBinding >, vsg::Inherit< Object, ArrayConfigurator >, vsg::Inherit< Object, VulkanInfo >, vsg::Inherit< Object, TransferTask >, vsg::Inherit< Object, SharedObjects >, vsg::Inherit< Object, Semaphore >, vsg::Inherit< Object, ScratchMemory >, vsg::Inherit< Object, External >, vsg::Inherit< Object, DescriptorPool >, vsg::Inherit< Object, ThreadSafeQueue< T > >, vsg::Inherit< Object, CommandBuffer >, vsg::Inherit< Object, RenderPass >, vsg::Inherit< Object, RecordAndSubmitTask >, vsg::Inherit< Object, Objects >, vsg::Inherit< Object, Device >, vsg::Inherit< Object, Implementation >, vsg::Inherit< Object, Builder >, vsg::Inherit< Object, Swapchain >, vsg::Inherit< Object, State >, vsg::Inherit< Object, LoadedObject >, vsg::Inherit< Object, FrameStamp >, vsg::Inherit< Object, DescriptorSet >, vsg::Inherit< Object, DatabasePager >, vsg::Inherit< Object, CompileManager >, vsg::Inherit< Object, AccelerationStructure >, vsg::Inherit< Object, AccelerationGeometry >, vsg::Inherit< Object, UpdateOperations >, vsg::Inherit< Object, DeviceMemory >, vsg::Inherit< Object, TextTechnique >, vsg::Inherit< Object, TextLayout >, vsg::Inherit< Object, Surface >, vsg::Inherit< Object, InstanceExtensions >, vsg::Inherit< Object, GraphicsPipelineConfigurator >, vsg::Inherit< Object, Font >, vsg::Inherit< Object, Descriptor >, vsg::Inherit< Object, AllocationCallbacks >, vsg::Inherit< Object, UIEvent >, vsg::Inherit< Object, ReaderWriter >, vsg::Inherit< Object, OperationThreads >, vsg::Inherit< Object, Latch >, vsg::Inherit< Object, Instance >, vsg::Inherit< Object, Image >, vsg::Inherit< Object, FrameBlock >, vsg::Inherit< Object, ViewDependentState >, vsg::Inherit< Object, Intersection >, vsg::Inherit< Object, DescriptorConfigurator >, vsg::Inherit< Object, WindowTraits >, vsg::Inherit< Object, Window >, vsg::Inherit< Object, Options >, vsg::Inherit< Object, Fence >, vsg::Inherit< Object, EllipsoidModel >, vsg::Inherit< Object, Context >, vsg::Inherit< Object, CommandPool >, vsg::Inherit< Object, BufferMemoryBarrier >, vsg::Inherit< Object, ViewMatrix >, vsg::Inherit< Object, ShaderModule >, vsg::Inherit< Object, ShaderCompileSettings >, vsg::Inherit< Object, Sampler >, vsg::Inherit< Object, ReadError >, vsg::Inherit< Object, PagedLODContainer >, vsg::Inherit< Object, Barrier >, vsg::Inherit< Object, ShaderSet >, vsg::Inherit< Object, RecordedCommandBuffers >, vsg::Inherit< Object, RayTracingPipeline >, vsg::Inherit< Object, MemoryBufferPools >, vsg::Inherit< Object, BufferView >, vsg::Inherit< Object, Viewer >, vsg::Inherit< Object, QueryPool >, vsg::Inherit< Object, ProjectionMatrix >, vsg::Inherit< Object, PipelineLayout >, vsg::Inherit< Object, PhysicalDevice >, vsg::Inherit< Object, GraphicsPipeline >, vsg::Inherit< Object, BufferInfo >, vsg::Inherit< Object, ShaderStage >, vsg::Inherit< Object, ResourceHints >, vsg::Inherit< Object, GraphicsPipelineState >, vsg::Inherit< Object, Event >, vsg::Inherit< Object, CulledPagedLODs >, vsg::Inherit< Object, ComputePipeline >, vsg::Inherit< Object, AnimationPath >, vsg::Inherit< Object, ActivityStatus >, vsg::Inherit< Object, Queue >, vsg::Inherit< Object, Presentation >, vsg::Inherit< Object, ImageInfo >, vsg::Inherit< Object, GeometryInstance >, vsg::Inherit< Object, DeviceFeatures >, vsg::Inherit< Object, DescriptorSetLayout >, vsg::Inherit< Object, Buffer >, vsg::ConstVisitor, vsg::Data, vsg::Logger, vsg::ObjectFactory, vsg::Operation, vsg::RecordTraversal, vsg::Visitor, vsgAndroid::KeyboardMap, vsgMacOS::KeyboardMap, vsgWin32::KeyboardMap, vsgXcb::KeyboardMap, and vsgiOS::KeyboardMap.

Public Member Functions
	Object (const Object &)
Object &	operator= (const Object &)
virtual std::size_t	sizeofObject () const noexcept
virtual const char *	className () const noexcept
virtual const std::type_info &	type_info () const noexcept
	return the std::type_info of this Object
virtual bool	is_compatible (const std::type_info &type) const noexcept
template<class T >
T *	cast ()
template<class T >
const T *	cast () const
virtual int	compare (const Object &rhs) const
	compare two objects, return -1 if this object is less than rhs, return 0 if it's equal, return 1 if rhs is greater,
virtual void	accept (Visitor &visitor)
virtual void	traverse (Visitor &)
virtual void	accept (ConstVisitor &visitor) const
virtual void	traverse (ConstVisitor &) const
virtual void	accept (RecordTraversal &visitor) const
virtual void	traverse (RecordTraversal &) const
virtual void	read (Input &input)
virtual void	write (Output &output) const
void	ref () const noexcept
void	unref () const noexcept
void	unref_nodelete () const noexcept
unsigned int	referenceCount () const noexcept
template<typename T >
void	setValue (const std::string &key, const T &value)
void	setValue (const std::string &key, const char *value)
	specialization of setValue to handle passing C strings
template<typename T >
bool	getValue (const std::string &key, T &value) const
	get specified value type, return false if value associated with key is not assigned or is not the correct type
void	setObject (const std::string &key, ref_ptr< Object > object)
	assign an Object associated with key
Object *	getObject (const std::string &key)
	get Object pointer associated with key, return nullptr if no object associated with key has been assigned
const Object *	getObject (const std::string &key) const
	get const Object pointer associated with key, return nullptr if no object associated with key has been assigned
template<class T >
T *	getObject (const std::string &key)
	get object pointer of specified type associated with key, return nullptr if no object associated with key has been assigned
template<class T >
const T *	getObject (const std::string &key) const
	get const object pointer of specified type associated with key, return nullptr if no object associated with key has been assigned
ref_ptr< Object >	getRefObject (const std::string &key)
	get ref_ptr<Object> associated with key, return nullptr if no object associated with key has been assigned
ref_ptr< const Object >	getRefObject (const std::string &key) const
	get ref_ptr<const Object> pointer associated with key, return nullptr if no object associated with key has been assigned
template<class T >
ref_ptr< T >	getRefObject (const std::string &key)
	get ref_ptr<T> of specified type associated with key, return nullptr if no object associated with key has been assigned
template<class T >
const ref_ptr< const T >	getRefObject (const std::string &key) const
	get ref_ptr<const T> of specified type associated with key, return nullptr if no object associated with key has been assigned
void	removeObject (const std::string &key)
	remove meta object or value associated with key
Auxiliary *	getOrCreateAuxiliary ()
Auxiliary *	getAuxiliary ()
const Auxiliary *	getAuxiliary () const

Static Public Member Functions
static ref_ptr< Object >	create ()
static ref_ptr< Object >	create_if (bool flag)
static void *	operator new (std::size_t count)
	provide new and delete to enable custom memory management via the vsg::Allocator singleton, using the MEMORY_AFFINTY_OBJECTS
static void	operator delete (void *ptr)

Protected Member Functions
virtual void	_attemptDelete () const
void	setAuxiliary (Auxiliary *auxiliary)

Friends
class	Auxiliary

Member Function Documentation

setValue()

template<typename T >

void vsg::Object::setValue	(	const std::string &	key,
		const T &	value
	)

meta data access methods wraps the value with a vsg::Value<T> object and then assigns via setObject(key, vsg::Value<T>)

---

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

• include/vsg/core/Object.h
• include/vsg/core/Value.h