svgtopt/gfx2d/inc/GfxLine2D.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
#ifndef GFXLINE2D_H
hgs
parents:
diff changeset
    20
#define GFXLINE2D_H
hgs
parents:
diff changeset
    21
hgs
parents:
diff changeset
    22
#include <e32std.h>
hgs
parents:
diff changeset
    23
hgs
parents:
diff changeset
    24
hgs
parents:
diff changeset
    25
#include "GfxFloatFixPt.h"
hgs
parents:
diff changeset
    26
#include "GfxRectangle2D.h"
hgs
parents:
diff changeset
    27
#include "GfxRectangularShape.h"
hgs
parents:
diff changeset
    28
#include "GfxPoint2D.h"
hgs
parents:
diff changeset
    29
#include "GfxPathIterator.h"
hgs
parents:
diff changeset
    30
#include "GfxAffineTransform.h"
hgs
parents:
diff changeset
    31
hgs
parents:
diff changeset
    32
hgs
parents:
diff changeset
    33
hgs
parents:
diff changeset
    34
/**
hgs
parents:
diff changeset
    35
 * Implementation of a line.
hgs
parents:
diff changeset
    36
 *
hgs
parents:
diff changeset
    37
 *  @lib Gfx2D.lib
hgs
parents:
diff changeset
    38
 *  @since 1.0
hgs
parents:
diff changeset
    39
 */
hgs
parents:
diff changeset
    40
class TGfxLine2D : public MGfxShape
hgs
parents:
diff changeset
    41
    {
hgs
parents:
diff changeset
    42
    public:
hgs
parents:
diff changeset
    43
hgs
parents:
diff changeset
    44
        /**
hgs
parents:
diff changeset
    45
         * Contructor.
hgs
parents:
diff changeset
    46
         *
hgs
parents:
diff changeset
    47
         * @since 1.0
hgs
parents:
diff changeset
    48
         * @param aX1 : x coordinate of starting point.
hgs
parents:
diff changeset
    49
         * @param aY1 : y coordinate of starting point.
hgs
parents:
diff changeset
    50
         * @param aX2 : x coordinate of ending point.
hgs
parents:
diff changeset
    51
         * @param aY2 : y coordinate of ending point.
hgs
parents:
diff changeset
    52
         * @return
hgs
parents:
diff changeset
    53
         */
hgs
parents:
diff changeset
    54
                 TGfxLine2D( const TFloatFixPt& aX1,
hgs
parents:
diff changeset
    55
                                     const TFloatFixPt& aY1,
hgs
parents:
diff changeset
    56
                                     const TFloatFixPt& aX2,
hgs
parents:
diff changeset
    57
                                     const TFloatFixPt& aY2 );
hgs
parents:
diff changeset
    58
hgs
parents:
diff changeset
    59
        /**
hgs
parents:
diff changeset
    60
         * Contructor.
hgs
parents:
diff changeset
    61
         *
hgs
parents:
diff changeset
    62
         * @since 1.0
hgs
parents:
diff changeset
    63
         * @param aP1 : starting point.
hgs
parents:
diff changeset
    64
         * @param aP2 : ending point.
hgs
parents:
diff changeset
    65
         * @return
hgs
parents:
diff changeset
    66
         */
hgs
parents:
diff changeset
    67
                TGfxLine2D( TGfxPoint2D aP1, TGfxPoint2D aP2 );
hgs
parents:
diff changeset
    68
hgs
parents:
diff changeset
    69
        //
hgs
parents:
diff changeset
    70
hgs
parents:
diff changeset
    71
        /**
hgs
parents:
diff changeset
    72
         * Get the length of this line.
hgs
parents:
diff changeset
    73
         *
hgs
parents:
diff changeset
    74
         * @since 1.0
hgs
parents:
diff changeset
    75
         * @return length
hgs
parents:
diff changeset
    76
         */
hgs
parents:
diff changeset
    77
         TFloatFixPt Length();
hgs
parents:
diff changeset
    78
hgs
parents:
diff changeset
    79
        // Implementation of MGfShape
hgs
parents:
diff changeset
    80
hgs
parents:
diff changeset
    81
        /**
hgs
parents:
diff changeset
    82
         * Get the bounding box.
hgs
parents:
diff changeset
    83
         *
hgs
parents:
diff changeset
    84
         * @since 1.0
hgs
parents:
diff changeset
    85
         * @param aAt : transform to apply.
hgs
parents:
diff changeset
    86
         * @param aRect : storage of bounding box info.
hgs
parents:
diff changeset
    87
         * @return
hgs
parents:
diff changeset
    88
         */
hgs
parents:
diff changeset
    89
         void   GetBounds( const TGfxAffineTransform& aAt,
hgs
parents:
diff changeset
    90
                                   TGfxRectangle2D& aRect );
hgs
parents:
diff changeset
    91
hgs
parents:
diff changeset
    92
        /**
hgs
parents:
diff changeset
    93
         * Get the path iterator for this line.
hgs
parents:
diff changeset
    94
         *
hgs
parents:
diff changeset
    95
         * @since 1.0
hgs
parents:
diff changeset
    96
         * @param aAt : transform to apply.
hgs
parents:
diff changeset
    97
         * @param aPitr : storage for iterator.
hgs
parents:
diff changeset
    98
         * @return
hgs
parents:
diff changeset
    99
         */
hgs
parents:
diff changeset
   100
         void   GetPathIteratorL( TGfxAffineTransform* aAt,
hgs
parents:
diff changeset
   101
                                          CGfxPathIterator*& aPitr );
hgs
parents:
diff changeset
   102
hgs
parents:
diff changeset
   103
        /**
hgs
parents:
diff changeset
   104
         * Get the path iterator for this line.
hgs
parents:
diff changeset
   105
         *
hgs
parents:
diff changeset
   106
         * @since 1.0
hgs
parents:
diff changeset
   107
         * @param aAt : transform to apply.
hgs
parents:
diff changeset
   108
         * @param aLimit : maximum of point to define iterator.
hgs
parents:
diff changeset
   109
         * @param aPitr : storage for iterator.
hgs
parents:
diff changeset
   110
         * @return
hgs
parents:
diff changeset
   111
         */
hgs
parents:
diff changeset
   112
         void   GetPathIteratorL( TGfxAffineTransform* aAt,
hgs
parents:
diff changeset
   113
                                          TInt aLimit,
hgs
parents:
diff changeset
   114
                                          CGfxPathIterator*& aPitr );
hgs
parents:
diff changeset
   115
hgs
parents:
diff changeset
   116
        /**
hgs
parents:
diff changeset
   117
         * Get area of this line: zero.
hgs
parents:
diff changeset
   118
         *
hgs
parents:
diff changeset
   119
         * @since 1.0
hgs
parents:
diff changeset
   120
         * @return
hgs
parents:
diff changeset
   121
         */
hgs
parents:
diff changeset
   122
        TFloatFixPt AreaSize();
hgs
parents:
diff changeset
   123
hgs
parents:
diff changeset
   124
hgs
parents:
diff changeset
   125
        /* Return shape type */
hgs
parents:
diff changeset
   126
        inline virtual TInt ShapeType () { return ELine; };
hgs
parents:
diff changeset
   127
hgs
parents:
diff changeset
   128
    public:
hgs
parents:
diff changeset
   129
        TFloatFixPt  iX1;
hgs
parents:
diff changeset
   130
        TFloatFixPt  iY1;
hgs
parents:
diff changeset
   131
        TFloatFixPt  iX2;
hgs
parents:
diff changeset
   132
        TFloatFixPt  iY2;
hgs
parents:
diff changeset
   133
    };
hgs
parents:
diff changeset
   134
hgs
parents:
diff changeset
   135
#endif      // GFXLINE2D_H