MSKPSlide Class Reference

#include <MSKPSlide.h>

Inheritance diagram for MSKPSlide:

Public Member Functions
	MSKPSlide (const SkString &name, const SkString &path)
	MSKPSlide (const SkString &name, std::unique_ptr< SkStreamSeekable >)
SkISize	getDimensions () const override
void	draw (SkCanvas *canvas) override
bool	animate (double nanos) override
void	load (SkScalar winWidth, SkScalar winHeight) override
void	unload () override
void	gpuTeardown () override
Public Member Functions inherited from Slide
virtual SkISize	getDimensions () const
virtual void	gpuTeardown ()
virtual void	draw (SkCanvas *canvas)=0
virtual bool	animate (double nanos)
virtual void	load (SkScalar winWidth, SkScalar winHeight)
virtual void	resize (SkScalar winWidth, SkScalar winHeight)
virtual void	unload ()
virtual bool	onChar (SkUnichar c)
virtual bool	onMouse (SkScalar x, SkScalar y, skui::InputState state, skui::ModifierKey modifiers)
virtual bool	onGetControls (SkMetaData *)
virtual void	onSetControls (const SkMetaData &)
const SkString &	getName ()
Public Member Functions inherited from SkRefCntBase
	SkRefCntBase ()
virtual	~SkRefCntBase ()
bool	unique () const
void	ref () const
void	unref () const

Additional Inherited Members
Protected Attributes inherited from Slide
SkString	fName

Detailed Description

Definition at line 23 of file MSKPSlide.h.

Constructor & Destructor Documentation

MSKPSlide() [1/2]

MSKPSlide::MSKPSlide	(	const SkString &	name,
		const SkString &	path
	)

Definition at line 24 of file MSKPSlide.cpp.

        : MSKPSlide(name, SkStream::MakeFromFile(path.c_str())) {}

MSKPSlide() [2/2]

MSKPSlide::MSKPSlide	(	const SkString &	name,
		std::unique_ptr< SkStreamSeekable >	stream
	)

Definition at line 27 of file MSKPSlide.cpp.

        : fStream(std::move(stream)) {
    fName = name;
}

Member Function Documentation

animate()

bool MSKPSlide::animate ( double  nanos )

overridevirtual

Reimplemented from Slide.

Definition at line 153 of file MSKPSlide.cpp.

                                    {
    if (!fPlayer || fPaused) {
        return false;
    }
    if (fLastFrameTime < 0) {
        // We're coming off being paused or switching from 1:1 mode to steady FPS. Advance 1 frame
        // and reset the frame time to start accumulating time from now.
        fFrame = (fFrame + 1)%fPlayer->numFrames();
        fLastFrameTime = nanos;
        return this->fPlayer->numFrames() > 1;
    }
    if (fFPS < 0) {
        // 1:1 mode. Always draw the next frame on each animation cycle.
        fFrame = (fFrame + 1)%fPlayer->numFrames();
        return this->fPlayer->numFrames() > 1;
    }
    double elapsed = nanos - fLastFrameTime;
    double frameTime = 1E9/fFPS;
    int framesToAdvance = elapsed/frameTime;
    fFrame = fFrame + framesToAdvance;
    if (fFrame >= fPlayer->numFrames()) {
        this->redrawLayers();
    }
    fFrame %= fPlayer->numFrames();
    // Instead of just adding elapsed, note the time when this frame should have begun.
    fLastFrameTime += framesToAdvance*frameTime;
    return framesToAdvance > 0;
}

draw()

void MSKPSlide::draw ( SkCanvas *  canvas )

overridevirtual

Implements Slide.

Definition at line 36 of file MSKPSlide.cpp.

                                     {
    if (!fPlayer) {
        ImGui::Text("Could not read mskp file %s.\n", fName.c_str());
        return;
    }
    ImGui::Begin("MSKP");
 
    ImGui::BeginGroup();
    // Play/Pause button
    if (ImGui::Button(fPaused ? "Play " : "Pause")) {
        fPaused = !fPaused;
        if (fPaused) {
            // This will ensure that when playback is unpaused we start on the current frame.
            fLastFrameTime = -1;
        }
    }
    // Control the frame rate of MSKP playback
    ImGui::Text("FPS: ");                   ImGui::SameLine();
    ImGui::RadioButton(  "1", &fFPS,    1); ImGui::SameLine();
    ImGui::RadioButton( "15", &fFPS,   15); ImGui::SameLine();
    ImGui::RadioButton( "30", &fFPS,   30); ImGui::SameLine();
    ImGui::RadioButton( "60", &fFPS,   60); ImGui::SameLine();
    ImGui::RadioButton("120", &fFPS,  120); ImGui::SameLine();
    ImGui::RadioButton("1:1", &fFPS,   -1); // Draw one MSKP frame for each real viewer frame.
    if (fFPS < 0) {
        // Like above, will cause onAnimate() to resume at current frame when FPS is changed
        // back to another frame rate.
        fLastFrameTime = -1;
    }
    // Frame control. Slider and +/- buttons. Ctrl-Click slider to type frame number.
    ImGui::Text("Frame:");
    ImGui::SameLine();
    ImGui::PushButtonRepeat(true);  // Enable click-and-hold for frame arrows.
    int oldFrame = fFrame;
    if (ImGui::ArrowButton("-mksp_frame", ImGuiDir_Left)) {
        fFrame = (fFrame + fPlayer->numFrames() - 1)%fPlayer->numFrames();
    }
    ImGui::SameLine();
    if (ImGui::SliderInt("##msk_frameslider", &fFrame, 0, fPlayer->numFrames()-1, "% 3d")) {
        fFrame = SkTPin(fFrame, 0, fPlayer->numFrames() - 1);
    }
    ImGui::SameLine();
    if (ImGui::ArrowButton("+mskp_frame", ImGuiDir_Right)) {
        fFrame = (fFrame + 1)%fPlayer->numFrames();
    }
    if (fFrame != oldFrame) {
        // When manually adjusting frames force layers to redraw.
        this->redrawLayers();
    }
 
    ImGui::PopButtonRepeat();
    ImGui::EndGroup();
 
    ImGui::BeginGroup();
    ImGui::Checkbox("Show Frame Bounds", &fShowFrameBounds);
    ImGui::SetNextItemWidth(200);
    ImGui::ColorPicker4("background", fBackgroundColor, ImGuiColorEditFlags_AlphaBar);
    // ImGui lets user enter out of range values by typing.
    for (float& component : fBackgroundColor) {
        component = SkTPin(component, 0.f, 1.f);
    }
    ImGui::EndGroup();
 
    // UI for visualizing contents of offscreen layers.
    ImGui::Text("Offscreen Layers "); ImGui::SameLine();
    ImGui::Checkbox("List All Layers", &fListAllLayers);
    ImGui::RadioButton("root", &fDrawLayerID, -1);
    const std::vector<int>& layerIDs = fListAllLayers ? fAllLayerIDs : fFrameLayerIDs[fFrame];
    fLayerIDStrings.resize(layerIDs.size());
    for (size_t i = 0; i < layerIDs.size(); ++i) {
        fLayerIDStrings[i] = SkStringPrintf("%d", layerIDs[i]);
        ImGui::RadioButton(fLayerIDStrings[i].c_str(), &fDrawLayerID, layerIDs[i]);
    }
    ImGui::End();
 
    auto bounds = SkIRect::MakeSize(fPlayer->frameDimensions(fFrame));
 
    if (fShowFrameBounds) {
        SkPaint boundsPaint;
        boundsPaint.setStyle(SkPaint::kStroke_Style);
        boundsPaint.setColor(SK_ColorRED);
        boundsPaint.setStrokeWidth(0.f);
        boundsPaint.setAntiAlias(true);
        // Outset so that at default scale we draw at pixel centers of the rows/cols surrounding the
        // bounds.
        canvas->drawRect(SkRect::Make(bounds).makeOutset(0.5f, 0.5f), boundsPaint);
    }
 
    canvas->save();
    if (fDrawLayerID >= 0) {
        // clip out the root layer content, but still call playFrame so layer contents are updated
        // to fFrame.
        bounds = SkIRect::MakeEmpty();
    }
    canvas->clipIRect(bounds);
    canvas->clear(SkColor4f{fBackgroundColor[0],
                            fBackgroundColor[1],
                            fBackgroundColor[2],
                            fBackgroundColor[3]});
    fPlayer->playFrame(canvas, fFrame);
    canvas->restore();
 
    if (fDrawLayerID >= 0) {
        if (sk_sp<SkImage> layerImage = fPlayer->layerSnapshot(fDrawLayerID)) {
            canvas->save();
            canvas->clipIRect(SkIRect::MakeSize(layerImage->dimensions()));
            canvas->clear(SkColor4f{fBackgroundColor[0],
                                    fBackgroundColor[1],
                                    fBackgroundColor[2],
                                    fBackgroundColor[3]});
            canvas->drawImage(std::move(layerImage), 0, 0);
            canvas->restore();
        }
        return;
    }
}

getDimensions()

SkISize MSKPSlide::getDimensions ( ) const

overridevirtual

A slide may have a content dimensions that is independent of the current window size. An empty size indicates that the Slide's dimensions are equal to the window's dimensions.

Reimplemented from Slide.

Definition at line 32 of file MSKPSlide.cpp.

                                       {
    return fPlayer ? fPlayer->maxDimensions() : SkISize{0, 0};
}

gpuTeardown()

void MSKPSlide::gpuTeardown ( )

overridevirtual

Reimplemented from Slide.

Definition at line 201 of file MSKPSlide.cpp.

                            {
    if (fPlayer) {
        fPlayer->resetLayers();
    }
}

load()

void MSKPSlide::load ( SkScalar  winWidth, SkScalar  winHeight  )

overridevirtual

Reimplemented from Slide.

Definition at line 182 of file MSKPSlide.cpp.

                                       {
    if (!fStream) {
        return;
    }
    fStream->rewind();
    fPlayer = MSKPPlayer::Make(fStream.get());
    if (!fPlayer) {
        return;
    }
    fAllLayerIDs = fPlayer->layerIDs();
    fFrameLayerIDs.clear();
    fFrameLayerIDs.resize(fPlayer->numFrames());
    for (int i = 0; i < fPlayer->numFrames(); ++i) {
        fFrameLayerIDs[i] = fPlayer->layerIDs(i);
    }
}

unload()

void MSKPSlide::unload ( )

overridevirtual

Reimplemented from Slide.

Definition at line 199 of file MSKPSlide.cpp.

{ fPlayer.reset(); }

---

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

• third_party/skia/tools/viewer/MSKPSlide.h
• third_party/skia/tools/viewer/MSKPSlide.cpp