struct hiro::draw::SkeletonStyle — HIRO 0.7.0 documentation

# struct hiro::draw::SkeletonStyle

## Overview

Structure specifying how the skeleton should be rendered. More…

    #include <SkeletonRenderer.h>

    struct SkeletonStyle: public hiro::draw::Style {
        // enums

        enum RenderMode;

        // fields

        hiro::shader::Material bonejoint_material { hiro::shader::Material(cogs::color::GRAY70) };
        bool display_basis { false };
        bool display_joints { true };
        hiro::draw::SkeletonStyle::RenderMode render_mode { hiro::draw::SkeletonStyle::RenderMode::octahedral };

        // methods

        virtual bool ReadFromStream(std::istream& str);
        virtual void WriteToStream(std::ostream& str);
    };

### Inherited Members

    public:
        // fields

        bool visible = true;
        cogs::Transform transform;

        // methods

        virtual bool ReadFromStream(std::istream& str);
        virtual void WriteToStream(std::ostream& str);

    protected:
        // methods

        bool ReadVersion(std::istream& str, const uint32_t expected_version);

## Detailed Documentation

Structure specifying how the skeleton should be rendered.

### Fields

    hiro::shader::Material bonejoint_material { hiro::shader::Material(cogs::color::GRAY70) }

Material used to render bones as well as joints of the skeleton.

    bool display_basis { false }

Defines whether the basis vectors of each individual bone should be displayed.

    bool display_joints { true }

When enabled, also joints will be rendered.

    hiro::draw::SkeletonStyle::RenderMode render_mode { hiro::draw::SkeletonStyle::RenderMode::octahedral }

Specifies the mode used to render the skeleton.

### Methods

    virtual bool ReadFromStream(std::istream& str)

Import state from stream.

    virtual void WriteToStream(std::ostream& str)

Export state to stream.