vsg 1.1.10
VulkanSceneGraph library
Loading...
Searching...
No Matches
vsg::StandardLayout Class Reference
Inheritance diagram for vsg::StandardLayout:
Collaboration diagram for vsg::StandardLayout:

Public Types

enum  Alignment {
  BASELINE_ALIGNMENT , LEFT_ALIGNMENT , TOP_ALIGNMENT = LEFT_ALIGNMENT , CENTER_ALIGNMENT ,
  RIGHT_ALIGNMENT , BOTTOM_ALIGNMENT = RIGHT_ALIGNMENT
}
enum  GlyphLayout { LEFT_TO_RIGHT_LAYOUT , RIGHT_TO_LEFT_LAYOUT , VERTICAL_LAYOUT }

Public Member Functions

void read (Input &input) override
void write (Output &output) const override
bool requiresBillboard () const override
void layout (const Data *text, const Font &font, TextQuads &texQuads) override
vec2 alignment (const Data *text, const Font &font) const override
dbox extents (const Data *text, const Font &font) const override
Public Member Functions inherited from vsg::Inherit< TextLayout, StandardLayout >
 Inherit (Args &&... args)
std::size_t sizeofObject () const noexcept override
const char * className () const noexcept override
const std::type_info & type_info () const noexcept override
bool is_compatible (const std::type_info &type) const noexcept override
int compare (const Object &rhs) const override
void accept (Visitor &visitor) override
Public Member Functions inherited from vsg::Inherit< Object, TextLayout >
 Inherit (Args &&... args)
Public Member Functions inherited from vsg::Object
 Object (const Object &object, const CopyOp &copyop={})
Objectoperator= (const Object &)
template<class T>
T * cast ()
template<class T>
const T * cast () const
virtual ref_ptr< Objectclone (const CopyOp &copyop={}) const
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
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
ObjectgetObject (const std::string &key)
 get Object pointer associated with key, return nullptr if no object associated with key has been assigned
const ObjectgetObject (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< ObjectgetRefObject (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 ObjectgetRefObject (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
AuxiliarygetOrCreateAuxiliary ()
AuxiliarygetAuxiliary ()
const AuxiliarygetAuxiliary () const

Public Attributes

Alignment horizontalAlignment = BASELINE_ALIGNMENT
Alignment verticalAlignment = BASELINE_ALIGNMENT
GlyphLayout glyphLayout = LEFT_TO_RIGHT_LAYOUT
vec3 position = vec3(0.0f, 0.0f, 0.0f)
vec3 horizontal = vec3(1.0f, 0.0f, 0.0f)
vec3 vertical = vec3(0.0f, 1.0f, 0.0f)
vec4 color = vec4(1.0f, 1.0f, 1.0f, 1.0f)
vec4 outlineColor = vec4(0.0f, 0.0f, 0.0f, 1.0f)
float outlineWidth = 0.0f
bool billboard = false
float billboardAutoScaleDistance = 0.0f

Additional Inherited Members

Static Public Member Functions inherited from vsg::Inherit< TextLayout, StandardLayout >
static ref_ptr< StandardLayoutcreate (Args &&... args)
static ref_ptr< StandardLayoutcreate_if (bool flag, Args &&... args)
Static Public Member Functions inherited from vsg::Inherit< Object, TextLayout >
static ref_ptr< TextLayoutcreate (Args &&... args)
static ref_ptr< TextLayoutcreate_if (bool flag, Args &&... args)
Static Public Member Functions inherited from vsg::Object
static ref_ptr< Objectcreate ()
static ref_ptr< Objectcreate_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 inherited from vsg::Object
virtual void _attemptDelete () const
void setAuxiliary (Auxiliary *auxiliary)

Member Function Documentation

◆ alignment()

vec2 vsg::StandardLayout::alignment ( const Data * text,
const Font & font ) const
overridevirtual

Implements vsg::TextLayout.

◆ extents()

dbox vsg::StandardLayout::extents ( const Data * text,
const Font & font ) const
overridevirtual

Implements vsg::TextLayout.

◆ layout()

void vsg::StandardLayout::layout ( const Data * text,
const Font & font,
TextQuads & texQuads )
overridevirtual

Implements vsg::TextLayout.

◆ read()

void vsg::StandardLayout::read ( Input & input)
overridevirtual

Reimplemented from vsg::Object.

◆ requiresBillboard()

bool vsg::StandardLayout::requiresBillboard ( ) const
inlineoverridevirtual

Reimplemented from vsg::TextLayout.

◆ write()

void vsg::StandardLayout::write ( Output & output) const
overridevirtual

Reimplemented from vsg::Object.


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