CNiPointer

CNi

previous page next page
Class CNiPointer Base ClassesData ItemsConstructorsDestructorsFunctionsGo to hierarchy chart    Prev page: operator =Next page: Color    
Class Declared in:
 NiPointer.h

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

CNiPointer encapsulates the interface to a single pointer on a knob or slide control, which allows you to modify its appearance and behavior.

You get individual pointers using the Pointers property on a CNiKnob or CNiSlide 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 pointer.
Public data CNiColor FillColor Specifies the fill color of the pointer.
Public data PointerFillStyles FillStyle Specifies how the function fills the pointer.
Public data long Index Specifies the index of this pointer in the CNiPointers collection.
Public data PointerModes Mode Specifies how the pointer behaves and responds to user input.
Public data CString Name Specifies the name of the pointer.
Public data PointerStyles Style Specifies the graphical style of the pointer.
Public data double Value Specifies the value of the pointer.
Public data long ValuePairIndex Specifies the index of the value pair selected by this pointer.
Public data bool Visible Specifies if the pointer is visible or hidden.

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

Public constructor

CNiPointer()

 Default constructor.
Public constructor

CNiPointer( CWPointer_CI* pCustom, CNiInterface::ThreadAccess option )

 Constructor that attaches to the specified CWPointer_CI pointer.
Public constructor

CNiPointer( const CNiPointer& source )

 Copy constructor.

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

Public destructor

~CNiPointer()

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

operator =( const CNiPointer& source )

 Assignment operator.

Shortcut to top of page. Example

// Set the style of the first pointer in the knob control.

CNiKnob knob;
CNiPointer pointer = knob.Pointers.Item(1);
pointer.Style = CNiPointer::Pointer3D;
previous page start next page