svgtopt/gfx2d/inc/GfxStroke.h
author hgs
Wed, 03 Nov 2010 18:56:10 +0200
changeset 46 88edb906c587
permissions -rw-r--r--
201044
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
46
hgs
parents:
diff changeset
     1
/*
hgs
parents:
diff changeset
     2
* Copyright (c) 2002 Nokia Corporation and/or its subsidiary(-ies).
hgs
parents:
diff changeset
     3
* All rights reserved.
hgs
parents:
diff changeset
     4
* This component and the accompanying materials are made available
hgs
parents:
diff changeset
     5
* under the terms of "Eclipse Public License v1.0"
hgs
parents:
diff changeset
     6
* which accompanies this distribution, and is available
hgs
parents:
diff changeset
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
hgs
parents:
diff changeset
     8
*
hgs
parents:
diff changeset
     9
* Initial Contributors:
hgs
parents:
diff changeset
    10
* Nokia Corporation - initial contribution.
hgs
parents:
diff changeset
    11
*
hgs
parents:
diff changeset
    12
* Contributors:
hgs
parents:
diff changeset
    13
*
hgs
parents:
diff changeset
    14
* Description:  Graphics Extension Library header file
hgs
parents:
diff changeset
    15
*
hgs
parents:
diff changeset
    16
*/
hgs
parents:
diff changeset
    17
hgs
parents:
diff changeset
    18
hgs
parents:
diff changeset
    19
hgs
parents:
diff changeset
    20
#ifndef GFXSTROKE_H
hgs
parents:
diff changeset
    21
#define GFXSTROKE_H
hgs
parents:
diff changeset
    22
hgs
parents:
diff changeset
    23
#include <e32std.h>
hgs
parents:
diff changeset
    24
#include <e32base.h>
hgs
parents:
diff changeset
    25
#include <fbs.h>
hgs
parents:
diff changeset
    26
#include "GfxFloatFixPt.h"
hgs
parents:
diff changeset
    27
hgs
parents:
diff changeset
    28
hgs
parents:
diff changeset
    29
hgs
parents:
diff changeset
    30
class CGfxGeneralPath;
hgs
parents:
diff changeset
    31
class MGfxShape;
hgs
parents:
diff changeset
    32
class CGfx2dGc;
hgs
parents:
diff changeset
    33
hgs
parents:
diff changeset
    34
hgs
parents:
diff changeset
    35
/**
hgs
parents:
diff changeset
    36
 *  Implementation of a Stroke.
hgs
parents:
diff changeset
    37
 *
hgs
parents:
diff changeset
    38
 *  @lib Gfx2D.lib
hgs
parents:
diff changeset
    39
 *  @since 1.0
hgs
parents:
diff changeset
    40
 */
hgs
parents:
diff changeset
    41
class TGfxStroke
hgs
parents:
diff changeset
    42
    {
hgs
parents:
diff changeset
    43
    public:
hgs
parents:
diff changeset
    44
hgs
parents:
diff changeset
    45
        /**
hgs
parents:
diff changeset
    46
         * Constructor.  Default values for width, join, cap and miter-limit.
hgs
parents:
diff changeset
    47
         *
hgs
parents:
diff changeset
    48
         * @since 1.0
hgs
parents:
diff changeset
    49
         * @return
hgs
parents:
diff changeset
    50
         */
hgs
parents:
diff changeset
    51
            TGfxStroke();
hgs
parents:
diff changeset
    52
hgs
parents:
diff changeset
    53
        /**
hgs
parents:
diff changeset
    54
         * Constructor.
hgs
parents:
diff changeset
    55
         *
hgs
parents:
diff changeset
    56
         * @since 1.0
hgs
parents:
diff changeset
    57
         * @param aStrokeWidth : width of stroke.
hgs
parents:
diff changeset
    58
         * @return
hgs
parents:
diff changeset
    59
         */
hgs
parents:
diff changeset
    60
            TGfxStroke( TFloatFixPt aStrokeWidth );
hgs
parents:
diff changeset
    61
hgs
parents:
diff changeset
    62
        /**
hgs
parents:
diff changeset
    63
         * Constructor.
hgs
parents:
diff changeset
    64
         *
hgs
parents:
diff changeset
    65
         * @since 1.0
hgs
parents:
diff changeset
    66
         * @param aStrokeWidth : width of stroke.
hgs
parents:
diff changeset
    67
         * @param aJoin : join type
hgs
parents:
diff changeset
    68
         * @param aCap : cap type
hgs
parents:
diff changeset
    69
         * @param aMiterLimit : miter-limit value.
hgs
parents:
diff changeset
    70
         * @return
hgs
parents:
diff changeset
    71
         */
hgs
parents:
diff changeset
    72
            TGfxStroke( TFloatFixPt aStrokeWidth,
hgs
parents:
diff changeset
    73
                                TGfxJoinType aJoin,
hgs
parents:
diff changeset
    74
                                TGfxCapType aCap,
hgs
parents:
diff changeset
    75
                                TFloatFixPt& aMiterLimit );
hgs
parents:
diff changeset
    76
hgs
parents:
diff changeset
    77
			void SetMiterLimit( TFloatFixPt aMiterLimit);
hgs
parents:
diff changeset
    78
			void SetJoinType( TGfxJoinType aJoin );
hgs
parents:
diff changeset
    79
			void SetCapType( TGfxCapType aCap );
hgs
parents:
diff changeset
    80
hgs
parents:
diff changeset
    81
        /**
hgs
parents:
diff changeset
    82
         * Set the stroke width
hgs
parents:
diff changeset
    83
         *
hgs
parents:
diff changeset
    84
         * @since 1.0
hgs
parents:
diff changeset
    85
         * @param aWidth : width of stroke.
hgs
parents:
diff changeset
    86
         * @return
hgs
parents:
diff changeset
    87
         */
hgs
parents:
diff changeset
    88
            void SetStrokeWidth( TFloatFixPt aWidth );
hgs
parents:
diff changeset
    89
hgs
parents:
diff changeset
    90
        /**
hgs
parents:
diff changeset
    91
         * Get the stroke width
hgs
parents:
diff changeset
    92
         *
hgs
parents:
diff changeset
    93
         * @since 1.0
hgs
parents:
diff changeset
    94
         * @return stroke width
hgs
parents:
diff changeset
    95
         */
hgs
parents:
diff changeset
    96
            TFloatFixPt StrokeWidth();
hgs
parents:
diff changeset
    97
			TGfxJoinType StrokeJoin();
hgs
parents:
diff changeset
    98
			TGfxCapType StrokeCap();
hgs
parents:
diff changeset
    99
			TFloatFixPt StrokeMiterLimit();
hgs
parents:
diff changeset
   100
hgs
parents:
diff changeset
   101
    protected:
hgs
parents:
diff changeset
   102
hgs
parents:
diff changeset
   103
        /**
hgs
parents:
diff changeset
   104
         * Get the stroke width, join type, cap type and miter-limit.
hgs
parents:
diff changeset
   105
         *
hgs
parents:
diff changeset
   106
         * @since 1.0
hgs
parents:
diff changeset
   107
         * @param aStrokeWidth : width of stroke.
hgs
parents:
diff changeset
   108
         * @param aJoin : join type
hgs
parents:
diff changeset
   109
         * @param aCap : cap type
hgs
parents:
diff changeset
   110
         * @param aMiterLimit : miter-limit value.
hgs
parents:
diff changeset
   111
         * @return
hgs
parents:
diff changeset
   112
         */
hgs
parents:
diff changeset
   113
        void            SetVars( TFloatFixPt aStrokeWidth,
hgs
parents:
diff changeset
   114
                                 TGfxJoinType aJoin,
hgs
parents:
diff changeset
   115
                                 TGfxCapType aCap,
hgs
parents:
diff changeset
   116
                                 const TFloatFixPt& aMiterLimit );
hgs
parents:
diff changeset
   117
hgs
parents:
diff changeset
   118
    protected:
hgs
parents:
diff changeset
   119
        TFloatFixPt          iStrokeWidth;
hgs
parents:
diff changeset
   120
        TGfxJoinType    iJoin;
hgs
parents:
diff changeset
   121
        TGfxCapType     iCap;
hgs
parents:
diff changeset
   122
        TFloatFixPt          iMiterLimit;
hgs
parents:
diff changeset
   123
hgs
parents:
diff changeset
   124
hgs
parents:
diff changeset
   125
    private:
hgs
parents:
diff changeset
   126
        friend          class CGfx2dGc;
hgs
parents:
diff changeset
   127
hgs
parents:
diff changeset
   128
    };
hgs
parents:
diff changeset
   129
hgs
parents:
diff changeset
   130
hgs
parents:
diff changeset
   131
#endif      // GFXSTROKE_H