CNiContours

3D Graph

previous page next page
Class CNiContours Base ClassesData ItemsConstructorsDestructorsFunctionsGo to hierarchy chart    Prev page: SetLevelListNext page: Anchor    
Class Declared in:
 NiContours.h

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

CNiContours encapsulates the interface to the Contours property of a CNiPlot3D object. This object allows you to modify the appearance and behavior of all contour lines in a 3D contour plot.

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 double Anchor Specifies the value of the contour anchor.
Public data bool AnchorEnabled Enables the contour anchor if true.
Public data Bases Basis Specifies the basis of the plot contours.
Public data short Count The number of objects in the collection.
Public data double Interval Specifies the distance between each contour level.
Public data CNiColor LabelColor Sets the label color for all contours in the collection.
Public data CNiFont LabelFont Sets the label font for all contours in the collection.
Public data CString LabelFormat Sets the label format string for all contours in the collection.
Public data bool LabelVisible Sets the label visibility for all contours in the collection.
Public data long Levels Specifies the number of contour levels for the plot.
Public data CNiColor LineColor Sets the line color for all contours in the collection.
Public data LineStyles LineStyle Sets the line style for all contours in the collection.
Public data double LineWidth Sets the line width for all contours in the collection.

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

Public constructor

CNiContours()

 Default constructor.
Public constructor

CNiContours( CWContours_CI* pCustom, CNiInterface::ThreadAccess option )

 Constructor that attaches to the specified CWContours_CI pointer.
Public constructor

CNiContours( const CNiContours& source )

 Copy constructor.

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

Public destructor

~CNiContours()

 Destructor.

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

Public function void

Add( double Level )

 Adds a new contour level to the collection of contours.
Public function static const IID &

GetIid()

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

GetLevelList( CNiReal64Vector& list )

 Gets the contour levels of the plot.
Public function CNiContour

Item( long itemIndex )

 Returns the specified contour object from the current collection of contours.
Public function const CNiContours &

operator =( const CNiContours& source )

 Assignment operator.
Public function void

Remove( long itemIndex )

 Removes the specified contour from the current collection of contours.
Public function void

RemoveAll()

 Removes all contours from the plot.
Public function void

SetLevelList( const CNiReal64Vector& list )

 Sets the contour levels for the plot.

Shortcut to top of page. Example

// Create a surface-contour plot.

CNiGraph3D graph;
CNiReal64Matrix data(20,20);
graph.Plot3DSimpleSurface(data);
CNiPlot3D plot = graph.Plots.Item(1);
plot.Style = CNiPlot3D::SurfaceContour;

// Change the label font on all contour lines in the plot to 12pt
// Courier and the contour line style to dashed.

CNiContours contours = plot.Contours;
contours.LabelFont.Name = "Courier";
contours.LabelFont.Size = 12;
contours.LineStyle = CNiContour::Dash;
previous page start next page