CNiShape

CNi

previous page next page
Class CNiShape Base ClassesData ItemsConstructorsDestructorsFunctionsGo to hierarchy chart    Prev page: SetCoordinatesNext page: Color    
Class Declared in:
 NiShape.h

'Overview' icon -- Shortcut to top of page. Overview

CNiShape encapsulates the interface to a single shape for an annotation on a graph control, which allows you to modify the appearance and behavior of the shape.

You get individual shapes using the Shape property on a CNiAnnotation object.

Note: To specify a date/time value, you must convert your date or time value to a double. A date is implemented as a floating-point value with the integer part of the number measuring days from midnight, 30 December 1899, and the fractional part representing the time of day. The absolute value of the fractional part of the number represents the time as a fraction of a day. Thus, 1 second equals 1 / 24 hours / 60 minutes, which is 1/86400 or approximately 1.157407e-5. So, midnight, 31 December 1899, is represented by 1.0. Similarly, 6 AM, 1 January 1900, is represented by 2.25, and midnight, 29 December 1899, is -1.0. However, 6 AM, 29 December 1899, is -1.25.

Hierarchy Chart Hierarchy Chart

'Base Classes' icon -- Shortcut to top of page. Base Classes

Public base class CNiInterface

'Data Items' icon -- Shortcut to top of page. Data Items

Public data CNiColor Color Specifies the color of the shape.
Public data bool FillVisible Specifies if the shape is filled with CNiShape::Color.
Public data CNiImage Image Specifies the shape image.
Public data CNiColor LineColor Specifies the line color of the shape.
Public data LineStyles LineStyle Specifies the line style of the shape.
Public data short LineWidth Specifies the line width of the shape.
Public data PointStyles PointStyle Specifies the point style for the shape.
Public data RegionAreas RegionArea Specifies the region area of the shape.
Public data Types Type Specifies the type of shape.
Public data CNiReal64Vector XCoordinates Specifies the x coordinates of the shape.
Public data CNiReal64Vector YCoordinates Specifies the y coordinates of the shape.

'Constructors' icon -- Shortcut to top of page. Constructors

Public constructor

CNiShape()

 Default constructor.
Public constructor

CNiShape( CWShape_CI* pCustom, CNiInterface::ThreadAccess option )

 Constructor that attaches to the specified CWShape_CI pointer.
Public constructor

CNiShape( const CNiShape& source )

 Copy constructor.

'Destructors' icon -- Shortcut to top of page. Destructors

Public destructor

~CNiShape()

 Destructor.

'Functions' icon -- Shortcut to top of page. Functions

Public function static const IID &

GetIid()

 Returns the globally unique identifier (GUID) of the ActiveX interface to which this class connects.
Public function const CNiShape &

operator =( const CNiShape& source )

 Assignment operator.
Public function void

SetCoordinates( const CNiVector & xCoordinates, const CNiVector & yCoordinates )

 Sets the x and y coordinates of the shape at the same time.

Shortcut to top of page. Example

    // Change the type of the shape on the first annotation.

    CNiGraph graph;
    CNiShape shape = graph.Annotations.Item(1).Shape;
    shape.Type = CNiShape::Rectangle;
previous page start next page