CNiCursor3D

3D Graph

previous page next page
Class CNiCursor3D Base ClassesData ItemsConstructorsDestructorsFunctionsGo to hierarchy chart    Prev page: SetPositionNext page: Column    
Class Declared in:
 NiCursor3D.h

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

CNiCursor3D encapsulates the interface to a single cursor on a graph control, which allows you to modify its appearance and behavior. You use cursors to enable your users to identify specific points on your 3D graph plots.

You get individual cursors using the Cursors property on a CNiGraph3D object.

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 long Column Specifies the row index of the point associated with the cursor on the plot.
Public data bool Enabled Specifies if the cursor generates mouse events or if you can drag the cursor in cursor tracking mode.
Public data CNiFont Font Specifies the cursor label font.
Public data CNiColor LineColor Specifies the color of the cursor point.
Public data LineStyles LineStyle Specifies the style of the cursor lines.
Public data double LineWidth Specifies the width of the cursor line.
Public data CString Name Specifies the name of the cursor.
Public data bool NameVisible Specifies if the cursor name is displayed next to the cursor.
Public data CNiColor PlaneColor Specifies the color of the cursor point.
Public data CNiPlot3D Plot Specifies the plot associated with the cursor.
Public data CNiColor PointColor Specifies the color of the cursor point.
Public data double PointSize Specifies the size of the cursor point in points.
Public data PointStyles PointStyle Specifies the style of the cursor point.
Public data bool PositionVisible Specifies if the cursor position is displayed next to the cursor.
Public data long Row Specifies the row index of the point associated with the cursor on the plot.
Public data SnapModes SnapMode Specifies the snap mode of the cursor.
Public data CNiColor TextBackColor Specifies the color of the cursor point.
Public data long TextBackgroundTransparency Specifies the transparency of the background drawn behind the cursor name and position text.
Public data CNiColor TextColor Specifies the color of the cursor point.
Public data long Transparency Indicates the percentage of transparency of the cursor planes.
Public data bool Visible Specifies if the cursor is visible or hidden.
Public data double XPosition Current x axis position of the cursor.
Public data bool XYPlaneVisible Specifies if a plane is displayed at the cursor Z value.
Public data bool XZPlaneVisible Specifies if a plane is displayed at the cursor Y value.
Public data double YPosition Current y axis position of the cursor.
Public data bool YZPlaneVisible Specifies if a plane is displayed at the cursor X value.
Public data double ZPosition Current z axis position of the cursor.

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

Public constructor

CNiCursor3D()

 Default constructor.
Public constructor

CNiCursor3D( CWCursor3D_CI* pCustom, CNiInterface::ThreadAccess option )

 Constructor that attaches to the specified CWCursor3D_CI pointer.
Public constructor

CNiCursor3D( const CNiCursor3D& source )

 Copy constructor.

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

Public destructor

~CNiCursor3D()

 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 CNiCursor3D &

operator =( const CNiCursor3D& source )

 Assignment operator.
Public function void

SetColor( const CNiColor & color )

 Sets the all the colors of the cursor at the same time.
Public function void

SetPosition( double xPosition, double yPosition, double zPosition )

 Sets the x, y, and z axis positions of the cursor at the same time.

Shortcut to top of page. Example

    // Change the snap mode of the first cursor on the graph.

    CNiGraph3D graph;
    CNiCursor3D cursor = graph.Cursors.Item(1);
    cursor.SnapMode = CNiCursor3D::SnapNearestPlot;
previous page start next page