Slic3r::GUI::AnimatedTexture Class Reference

#include </home/runner/work/OrcaSlicer/OrcaSlicer/src/slic3r/GUI/AnimatedTexture.hpp>

Collaboration diagram for Slic3r::GUI::AnimatedTexture:

Classes
struct	Frame

Public Member Functions
	AnimatedTexture ()=default
	AnimatedTexture (AnimatedTexture &&)=default
AnimatedTexture &	operator= (AnimatedTexture &&)=default
	AnimatedTexture (const AnimatedTexture &)=delete
AnimatedTexture &	operator= (const AnimatedTexture &)=delete
bool	load_from_file (const std::string &path)
void	reset ()
bool	is_valid () const
bool	is_animated () const
int	width () const
int	height () const
double	duration () const
unsigned int	texture_id (double time) const

Private Attributes
std::vector< Frame >	m_frames
int	m_width {0}
int	m_height {0}
double	m_duration {0.}

Detailed Description

---

Class Documentation

Slic3r::GUI::AnimatedTexture::Frame

struct Slic3r::GUI::AnimatedTexture::Frame

Collaboration diagram for Slic3r::GUI::AnimatedTexture::Frame:

Class Members
double	delay {0.}
double	start {0.}
unique_ptr< GLTexture >	texture

Constructor & Destructor Documentation

AnimatedTexture() [1/3]

Slic3r::GUI::AnimatedTexture::AnimatedTexture ( )

default

Referenced by AnimatedTexture(), AnimatedTexture(), operator=(), and operator=().

Here is the caller graph for this function:

AnimatedTexture() [2/3]

Slic3r::GUI::AnimatedTexture::AnimatedTexture ( AnimatedTexture && )

default

References AnimatedTexture().

Here is the call graph for this function:

AnimatedTexture() [3/3]

Slic3r::GUI::AnimatedTexture::AnimatedTexture ( const AnimatedTexture & )

delete

References AnimatedTexture().

Here is the call graph for this function:

Member Function Documentation

duration()

double Slic3r::GUI::AnimatedTexture::duration ( ) const

inline

{ return m_duration; }

References m_duration.

height()

int Slic3r::GUI::AnimatedTexture::height ( ) const

inline

{ return m_height; }

References m_height.

Referenced by load_from_file(), and Slic3r::GUI::GLGizmoTextureDisplacement::render_tip_media().

Here is the caller graph for this function:

is_animated()

bool Slic3r::GUI::AnimatedTexture::is_animated ( ) const

inline

{ return m_frames.size() > 1; }

References m_frames.

Referenced by Slic3r::GUI::GLGizmoTextureDisplacement::render_tip_media().

Here is the caller graph for this function:

is_valid()

bool Slic3r::GUI::AnimatedTexture::is_valid ( ) const

inline

{ return !m_frames.empty(); }

References m_frames.

Referenced by Slic3r::GUI::GLGizmoTextureDisplacement::render_tip_media().

Here is the caller graph for this function:

load_from_file()

bool Slic3r::GUI::AnimatedTexture::load_from_file

(

const std::string &

path

)

{
    reset();
 
    boost::system::error_code ec;
    if (!boost::filesystem::is_regular_file(path, ec))
        return false;
 
    const std::vector<unsigned char> bytes = read_file_bytes(path);
    if (bytes.empty())
        return false;
 
    std::vector<DecodedFrame> frames;
    int                       width = 0, height = 0;
 
    if (has_gif_signature(bytes)) {
        if (!decode_gif(bytes, width, height, frames)) {
            BOOST_LOG_TRIVIAL(error) << "AnimatedTexture: cannot decode GIF " << path;
            return false;
        }
    } else {
        wxLogNull           no_log; // a format wxWidgets cannot read is handled here, not in a dialog
        wxImage             image;
        wxMemoryInputStream stream(bytes.data(), bytes.size());
        if (!image.LoadFile(stream, wxBITMAP_TYPE_ANY) || !image.IsOk()) {
            BOOST_LOG_TRIVIAL(error) << "AnimatedTexture: cannot decode image " << path;
            return false;
        }
        width  = image.GetWidth();
        height = image.GetHeight();
        frames.push_back({ image_to_rgba(image), 0.0 });
    }
 
    m_width  = width;
    m_height = height;
    m_frames.reserve(frames.size());
    for (DecodedFrame &frame : frames) {
        auto texture = std::make_unique<GLTexture>();
        // Mipmapped: a hint is drawn at whatever width the panel has room for, which is usually
        // smaller than the source, and an unfiltered downscale of a diagram is all aliasing.
        if (!texture->load_from_raw_data(std::move(frame.rgba), (unsigned int) width, (unsigned int) height, false,
                                         /* use_mipmaps */ true)) {
            BOOST_LOG_TRIVIAL(error) << "AnimatedTexture: cannot upload " << path;
            reset();
            return false;
        }
        m_frames.push_back({ std::move(texture), m_duration, frame.delay });
        m_duration += frame.delay;
    }
    return true;
}

References height(), m_duration, m_frames, m_height, m_width, reset(), and width().

Here is the call graph for this function:

operator=() [1/2]

AnimatedTexture & Slic3r::GUI::AnimatedTexture::operator= ( AnimatedTexture && )

default

References AnimatedTexture().

Here is the call graph for this function:

operator=() [2/2]

AnimatedTexture & Slic3r::GUI::AnimatedTexture::operator= ( const AnimatedTexture & )

delete

References AnimatedTexture().

Here is the call graph for this function:

reset()

void Slic3r::GUI::AnimatedTexture::reset

(

)

{
    m_frames.clear();
    m_width    = 0;
    m_height   = 0;
    m_duration = 0.;
}

References m_duration, m_frames, m_height, and m_width.

Referenced by load_from_file().

Here is the caller graph for this function:

texture_id()

unsigned int Slic3r::GUI::AnimatedTexture::texture_id

(

double

time

)

const

{
    if (m_frames.empty())
        return 0;
    if (m_frames.size() == 1 || m_duration <= 0.)
        return m_frames.front().texture->get_id();
 
    const double t = time - m_duration * std::floor(time / m_duration);
    // Frames are few; a linear walk beats keeping an index around and getting it stale.
    size_t i = 0;
    while (i + 1 < m_frames.size() && t >= m_frames[i].start + m_frames[i].delay)
        ++i;
    return m_frames[i].texture->get_id();
}

References m_duration, and m_frames.

Referenced by Slic3r::GUI::GLGizmoTextureDisplacement::render_tip_media().

Here is the caller graph for this function:

width()

int Slic3r::GUI::AnimatedTexture::width ( ) const

inline

{ return m_width; }

References m_width.

Referenced by load_from_file(), and Slic3r::GUI::GLGizmoTextureDisplacement::render_tip_media().

Here is the caller graph for this function:

Member Data Documentation

m_duration

double Slic3r::GUI::AnimatedTexture::m_duration {0.}

private

{0.};

Referenced by duration(), load_from_file(), reset(), and texture_id().

m_frames

std::vector<Frame> Slic3r::GUI::AnimatedTexture::m_frames

private

Referenced by is_animated(), is_valid(), load_from_file(), reset(), and texture_id().

m_height

int Slic3r::GUI::AnimatedTexture::m_height {0}

private

{0};

Referenced by height(), load_from_file(), and reset().

m_width

int Slic3r::GUI::AnimatedTexture::m_width {0}

private

{0};

Referenced by load_from_file(), reset(), and width().

---

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

• /home/runner/work/OrcaSlicer/OrcaSlicer/src/slic3r/GUI/AnimatedTexture.hpp
• /home/runner/work/OrcaSlicer/OrcaSlicer/src/slic3r/GUI/AnimatedTexture.cpp