xref: /aoo41x/main/offapi/com/sun/star/rendering/AnimationRepeat.idl (revision cdf0e10c)

/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#ifndef __com_sun_star_rendering_AnimationRepeat_idl__
#define __com_sun_star_rendering_AnimationRepeat_idl__

module com { module sun { module star { module rendering {

/** This are the possible repeat modes for animations.<p>

	These constants determine how the [0,1] parameter range of the
	animation is driven through, thus defining the possible repeat
	modes.<p>

    @since OOo 2.0
 */
constants AnimationRepeat
{
    /** The [0,1] parameter range is sweeped through exactly once.<p>

    	The [0,1] parameter range is sweeped through exactly once,
    	starting with 0 and ending with 1.<p>
    */
    const byte ONE_SHOT=0;

	//-------------------------------------------------------------------------

    /** The [0,1] parameter range is sweeped through exactly twice.<p>

    	The [0,1] parameter range is sweeped through exactly twice,
    	starting with 0, going to 1, and going back to 0. When
    	plotting the value over time, this yields a triangle curve.<p>
    */
    const byte ONE_SHOT_PINGPONG=1;

	//-------------------------------------------------------------------------

    /** The [0,1] parameter range is sweeped through infinitely.<p>

    	The [0,1] parameter range is sweeped through infinitely,
    	starting with 0, going to 1, and going back to 0, and then
    	starting again. When plotting the value over time, this yields
    	a repeated triangle curve.<p>
    */
    const byte PINGPONG=2;

	//-------------------------------------------------------------------------

    /** The [0,1] parameter range is sweeped through infinitely.<p>

    	The [0,1] parameter range is sweeped through infinitely,
    	starting with 0, going to 1, and starting with 0 again. When
    	plotting the value over time, this yields a repeated saw-tooth
    	curve.<p>
    */
    const byte REPEAT=3;
};

}; }; }; };

#endif