summaryrefslogtreecommitdiff
path: root/modules/graphics/macros/get_figure_handle.sci
blob: 770653a0a7ce97e6ec03b1aaf6bd17b2911913ea (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
// Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
// Copyright (C) 2008 - INRIA - Jean-Baptiste Silvy
// This file must be used under the terms of the CeCILL.
// This source file is licensed as described in the file COPYING, which
// you should have received as part of this distribution.  The terms
// are also available at
// http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt


function [fig]=get_figure_handle(index)

    if argn(2)<>1 then
        error(msprintf(gettext("%s: Wrong number of input argument(s): %d expected.\n"), "get_figure_handle", 1));
    end

    // check index
    figureIndices = winsid();
    // check that index is within the opened windows
    if (find(figureIndices == index) == []) then
        fig = [];
        return;
    end

    // return the figure handle from its index
    curFig = gcf();
    fig = scf(index);

    // scf sets the figure, so switch back to curFig
    scf(curFig);

endfunction