#include <kis_timing_information.h>

Public Member Functions
bool	isTimedSpacingEnabled () const

	KisTimingInformation ()

	KisTimingInformation (qreal interval)

qreal	timedSpacingInterval () const

Private Attributes
bool	m_timedSpacingEnabled

qreal	m_timedSpacingInterval

Detailed Description

Contains information about timing settings in a stroke (mainly for airbrushing effects). The timing settings may be different at different parts of a stroke, e.g. if the airbrush rate is linked to pressure; a KisTimingInformation represents the effective timing at a single specific part of a stroke.

Definition at line 23 of file kis_timing_information.h.

Constructor & Destructor Documentation

◆ KisTimingInformation() [1/2]

KisTimingInformation::KisTimingInformation ( )

inlineexplicit

Makes a KisTimingInformation with timed spacing disabled.

Definition at line 28 of file kis_timing_information.h.

        : m_timedSpacingEnabled(false)
        , m_timedSpacingInterval(LONG_TIME)
    {
    }

◆ KisTimingInformation() [2/2]

KisTimingInformation::KisTimingInformation ( qreal interval )

inlineexplicit

Makes a KisTimingInformation with timed spacing enabled, using the specified interval in milliseconds.

Definition at line 38 of file kis_timing_information.h.

        : m_timedSpacingEnabled(true)
        , m_timedSpacingInterval(interval)
    {
    }

Member Function Documentation

◆ isTimedSpacingEnabled()

bool KisTimingInformation::isTimedSpacingEnabled ( ) const

inline

Returns: True if and only if time-based spacing is enabled.

Definition at line 47 of file kis_timing_information.h.

                                              {
        return m_timedSpacingEnabled;
    }

◆ timedSpacingInterval()

qreal KisTimingInformation::timedSpacingInterval ( ) const

inline

Returns: The desired maximum amount of time between dabs, in milliseconds. Returns LONG_TIME if time-based spacing is disabled.

Definition at line 55 of file kis_timing_information.h.

                                              {
        return isTimedSpacingEnabled() ?
                    m_timedSpacingInterval :
                    LONG_TIME;
    }

References LONG_TIME.

Member Data Documentation

◆ m_timedSpacingEnabled

bool KisTimingInformation::m_timedSpacingEnabled

private

Definition at line 63 of file kis_timing_information.h.

◆ m_timedSpacingInterval

qreal KisTimingInformation::m_timedSpacingInterval