svgtopt/gfx2d/inc/GfxPoint2D.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 GFXPOINT2D_H
hgs
parents:
diff changeset
    20
#define GFXPOINT2D_H
hgs
parents:
diff changeset
    21
hgs
parents:
diff changeset
    22
#include <e32std.h>
hgs
parents:
diff changeset
    23
#include "GfxFloatFixPt.h"
hgs
parents:
diff changeset
    24
hgs
parents:
diff changeset
    25
hgs
parents:
diff changeset
    26
/**
hgs
parents:
diff changeset
    27
 * Implementation of a 2D point.
hgs
parents:
diff changeset
    28
 *
hgs
parents:
diff changeset
    29
 *  @lib Gfx2D.lib
hgs
parents:
diff changeset
    30
 *  @since 1.0
hgs
parents:
diff changeset
    31
 */
hgs
parents:
diff changeset
    32
class TGfxPoint2D
hgs
parents:
diff changeset
    33
    {
hgs
parents:
diff changeset
    34
    public:
hgs
parents:
diff changeset
    35
hgs
parents:
diff changeset
    36
        /**
hgs
parents:
diff changeset
    37
         * Constructor.  Default coordinates to (0, 0).
hgs
parents:
diff changeset
    38
         *
hgs
parents:
diff changeset
    39
         * @since 1.0
hgs
parents:
diff changeset
    40
         * @return
hgs
parents:
diff changeset
    41
         */
hgs
parents:
diff changeset
    42
         TGfxPoint2D();
hgs
parents:
diff changeset
    43
hgs
parents:
diff changeset
    44
        /**
hgs
parents:
diff changeset
    45
         * Constructor.  Define point to be at the given coordinates.
hgs
parents:
diff changeset
    46
         *
hgs
parents:
diff changeset
    47
         * @since 1.0
hgs
parents:
diff changeset
    48
         * @param aX : x coordinate
hgs
parents:
diff changeset
    49
         * @param aY : y coordinate
hgs
parents:
diff changeset
    50
         * @return
hgs
parents:
diff changeset
    51
         */
hgs
parents:
diff changeset
    52
         TGfxPoint2D( TFloatFixPt aX, TFloatFixPt aY );
hgs
parents:
diff changeset
    53
hgs
parents:
diff changeset
    54
        /**
hgs
parents:
diff changeset
    55
         * Get distance between this point and the given point.
hgs
parents:
diff changeset
    56
         *
hgs
parents:
diff changeset
    57
         * @since 1.0
hgs
parents:
diff changeset
    58
         * @param aPoint : point for distance calculation
hgs
parents:
diff changeset
    59
         * @return distance between two points.
hgs
parents:
diff changeset
    60
         */
hgs
parents:
diff changeset
    61
         TFloatFixPt Distance( const TGfxPoint2D& aPoint );
hgs
parents:
diff changeset
    62
hgs
parents:
diff changeset
    63
        /**
hgs
parents:
diff changeset
    64
         * Get distance squared between this point and the given point.
hgs
parents:
diff changeset
    65
         *
hgs
parents:
diff changeset
    66
         * @since 1.0
hgs
parents:
diff changeset
    67
         * @param aPoint : point for distance calculation
hgs
parents:
diff changeset
    68
         * @return distance squared between two points.
hgs
parents:
diff changeset
    69
         */
hgs
parents:
diff changeset
    70
         TFloatFixPt DistanceSq( const TGfxPoint2D& aPoint );
hgs
parents:
diff changeset
    71
		
hgs
parents:
diff changeset
    72
		 TInt operator==( const TGfxPoint2D& aPoint ) const;
hgs
parents:
diff changeset
    73
		
hgs
parents:
diff changeset
    74
		 TInt operator!=( const TGfxPoint2D& aPoint ) const;
hgs
parents:
diff changeset
    75
		
hgs
parents:
diff changeset
    76
    public:
hgs
parents:
diff changeset
    77
        // Coordinates
hgs
parents:
diff changeset
    78
        TFloatFixPt          iX;
hgs
parents:
diff changeset
    79
        TFloatFixPt          iY;
hgs
parents:
diff changeset
    80
    };
hgs
parents:
diff changeset
    81
hgs
parents:
diff changeset
    82
#endif      // GFXPOINT2D_H