OpenCMISS-Zinc C++ API Documentation
Public Member Functions | Friends | List of all members
OpenCMISS::Zinc::GraphicsContours Class Reference

The contours derived graphics type. More...

#include <graphics.hpp>

Inheritance diagram for OpenCMISS::Zinc::GraphicsContours:
OpenCMISS::Zinc::Graphics

Public Member Functions

 GraphicsContours (cmzn_graphics_contours_id contours_id)
 
Field getIsoscalarField ()
 
int setIsoscalarField (const Field &field)
 
int getListIsovalues (int valuesCount, double *valuesOut)
 
int setListIsovalues (int valuesCount, const double *valuesIn)
 
double getRangeFirstIsovalue ()
 
double getRangeLastIsovalue ()
 
int getRangeNumberOfIsovalues ()
 
int setRangeIsovalues (int numberOfValues, double firstIsovalue, double lastIsovalue)
 
- Public Member Functions inherited from OpenCMISS::Zinc::Graphics
 Graphics (cmzn_graphics_id graphics_id)
 
 Graphics (const Graphics &graphics)
 
Graphicsoperator= (const Graphics &graphics)
 
bool isValid () const
 
cmzn_graphics_id getId () const
 
Field getCoordinateField ()
 
int setCoordinateField (const Field &coordinateField)
 
Field getDataField ()
 
int setDataField (const Field &dataField)
 
double getRenderLineWidth ()
 
int setRenderLineWidth (double width)
 
double getRenderPointSize ()
 
int setRenderPointSize (double size)
 
enum RenderPolygonMode getRenderPolygonMode ()
 
int setRenderPolygonMode (RenderPolygonMode renderPolygonMode)
 
Scene getScene ()
 
enum SelectMode getSelectMode ()
 
int setSelectMode (SelectMode selectMode)
 
Field getSubgroupField ()
 
int setSubgroupField (const Field &subgroupField)
 
Field getTextureCoordinateField ()
 
int setTextureCoordinateField (const Field &textureCoordinateField)
 
Material getMaterial ()
 
int setMaterial (const Material &material)
 
Graphicslineattributes getGraphicslineattributes ()
 
Graphicspointattributes getGraphicspointattributes ()
 
Graphicssamplingattributes getGraphicssamplingattributes ()
 
Material getSelectedMaterial ()
 
int setSelectedMaterial (const Material &material)
 
Spectrum getSpectrum ()
 
int setSpectrum (const Spectrum &spectrum)
 
enum Type getType ()
 
Tessellation getTessellation ()
 
int setTessellation (const Tessellation &tessellation)
 
Field getTessellationField ()
 
int setTessellationField (const Field &tessellationField)
 
bool getVisibilityFlag ()
 
int setVisibilityFlag (bool visibilityFlag)
 
enum Scenecoordinatesystem getScenecoordinatesystem ()
 
int setScenecoordinatesystem (Scenecoordinatesystem coordinateSystem)
 
Field::DomainType getFieldDomainType ()
 
int setFieldDomainType (Field::DomainType domainType)
 
char * getName ()
 
int setName (const char *name)
 
int setElementFaceType (Element::FaceType faceType)
 
Element::FaceType getElementFaceType ()
 
bool isExterior ()
 
int setExterior (bool exterior)
 
GraphicsContours castContours ()
 
GraphicsLines castLines ()
 
GraphicsPoints castPoints ()
 
GraphicsStreamlines castStreamlines ()
 
GraphicsSurfaces castSurfaces ()
 

Friends

class Scene
 

Additional Inherited Members

- Public Types inherited from OpenCMISS::Zinc::Graphics
enum  RenderPolygonMode { RENDER_POLYGON_MODE_INVALID = CMZN_GRAPHICS_RENDER_POLYGON_MODE_INVALID, RENDER_POLYGON_MODE_SHADED = CMZN_GRAPHICS_RENDER_POLYGON_MODE_SHADED, RENDER_POLYGON_MODE_WIREFRAME = CMZN_GRAPHICS_RENDER_POLYGON_MODE_WIREFRAME }
 
enum  SelectMode {
  SELECT_MODE_INVALID = CMZN_GRAPHICS_SELECT_MODE_INVALID, SELECT_MODE_ON = CMZN_GRAPHICS_SELECT_MODE_ON, SELECT_MODE_OFF = CMZN_GRAPHICS_SELECT_MODE_OFF, SELECT_MODE_DRAW_SELECTED = CMZN_GRAPHICS_SELECT_MODE_DRAW_SELECTED,
  SELECT_MODE_DRAW_UNSELECTED = CMZN_GRAPHICS_SELECT_MODE_DRAW_UNSELECTED
}
 
enum  Type {
  TYPE_INVALID = CMZN_GRAPHICS_TYPE_INVALID, TYPE_POINTS = CMZN_GRAPHICS_TYPE_POINTS, TYPE_LINES = CMZN_GRAPHICS_TYPE_LINES, TYPE_SURFACES = CMZN_GRAPHICS_TYPE_SURFACES,
  TYPE_CONTOURS = CMZN_GRAPHICS_TYPE_CONTOURS, TYPE_STREAMLINES = CMZN_GRAPHICS_TYPE_STREAMLINES
}
 
- Protected Attributes inherited from OpenCMISS::Zinc::Graphics
cmzn_graphics_id id
 

Detailed Description

The contours derived graphics type.

The contours derived graphics type. Produces graphics visualising where the 'iso-scalar' field equals fixed values: iso-surfaces on 3-D domains, iso-lines on 2-D domains.

Member Function Documentation

Field OpenCMISS::Zinc::GraphicsContours::getIsoscalarField ( )
inline

Gets the isoscalar field for the contours graphics.

Returns
Handle to isoscalar field, or NULL/invalid handle if none or failed.
int OpenCMISS::Zinc::GraphicsContours::getListIsovalues ( int  valuesCount,
double *  valuesOut 
)
inline

Get the iso values for the contours graphics when it has been set as an explicit list.

See also
GraphicsContours::setListIsovalues.
Parameters
valuesCountThe size of the isovalues array.
valuesOutArray to receive number_of_isovalues iso values.
Returns
The actual number of iso values that have been explicitly set using GraphicsContours::setListIsovalues. This can be more than the number requested, so a second call may be needed with a larger array. A zero return value can indicate isovalues were set as a range, not as an explicit list.
double OpenCMISS::Zinc::GraphicsContours::getRangeFirstIsovalue ( )
inline

Get the first isovalue for the contours graphics when set as a range.

See also
GraphicsContours::setRangeIsovalues
Returns
First iso values in the range, or 0.0 if not set as a range or other error.
double OpenCMISS::Zinc::GraphicsContours::getRangeLastIsovalue ( )
inline

Get the last isovalue for the contours graphics when set as a range.

See also
GraphicsContours::setRangeIsovalues
Returns
Last iso values in the range, or 0.0 if not set as a range or other error.
int OpenCMISS::Zinc::GraphicsContours::getRangeNumberOfIsovalues ( )
inline

Get the number of isovalues for the contours graphics when set as a range.

See also
GraphicsContours::setRangeIsovalues
Returns
Number of iso values in the range, or 0 if not set as a range or other error.
int OpenCMISS::Zinc::GraphicsContours::setIsoscalarField ( const Field field)
inline

Set the isoscalar field for the contours graphics.

Parameters
fieldThe isoscalar field to set, this field must have only one component.
Returns
Status OpenCMISS::Zinc::OK on success, otherwise OpenCMISS::Zinc::ERROR_ARGUMENT.
int OpenCMISS::Zinc::GraphicsContours::setListIsovalues ( int  valuesCount,
const double *  valuesIn 
)
inline

Set the iso values for the contours graphics as an explicit list.

Parameters
valuesCountThe number of values in the isovalues array.
valuesInThe array of number_of_isovalues double values.
Returns
Status OpenCMISS::Zinc::OK on success, otherwise any error code.
int OpenCMISS::Zinc::GraphicsContours::setRangeIsovalues ( int  numberOfValues,
double  firstIsovalue,
double  lastIsovalue 
)
inline

Set the isovalues for the contours graphics as a number in a range from first isovalue to last isovalue, in uniform increments. For example, 5 values from 0.0 to 1.0 gives: 0.0, 0.25, 0.5, 0.75 and 1.0.

Parameters
numberOfValuesThe number of contours from the first to the last isovalue.
firstIsovalueThe first iso value.
lastIsovalueThe last iso value.
Returns
Status OpenCMISS::Zinc::OK on success, otherwise OpenCMISS::Zinc::ERROR_ARGUMENT.

The documentation for this class was generated from the following file: