OpenCMISS-Zinc C++ API Documentation
Public Member Functions | Protected Attributes | List of all members
OpenCMISS::Zinc::Graphicssamplingattributes Class Reference

Graphics attributes object specifying how points are sampled in elements. More...

#include <graphics.hpp>

Public Member Functions

 Graphicssamplingattributes (cmzn_graphicssamplingattributes_id sampling_attributes_id)
 
 Graphicssamplingattributes (const Graphicssamplingattributes &samplingAttributes)
 
Graphicssamplingattributesoperator= (const Graphicssamplingattributes &graphicssamplingattributes)
 
bool isValid () const
 
Field getDensityField ()
 
int setDensityField (const Field &densityField)
 
int getLocation (int valuesCount, double *valuesOut)
 
int setLocation (int valuesCount, const double *valuesIn)
 
Element::PointSamplingMode getElementPointSamplingMode ()
 
int setElementPointSamplingMode (Element::PointSamplingMode samplingMode)
 

Protected Attributes

cmzn_graphicssamplingattributes_id id
 

Detailed Description

Graphics attributes object specifying how points are sampled in elements.

Graphics attributes object specifying how points are sampled in elements, including sampling mode, density, etc.

See also
Graphics::getGraphicssamplingattributes

Member Function Documentation

Field OpenCMISS::Zinc::Graphicssamplingattributes::getDensityField ( )
inline

Gets the scalar field specifying the density of points sampled from elements when used with CELL_POISSON sampling mode.

Returns
Handle to density field, or NULL/invalid handle if none or failed.
Element::PointSamplingMode OpenCMISS::Zinc::Graphicssamplingattributes::getElementPointSamplingMode ( )
inline

Get the mode for sampling points in elements.

Returns
The point sampling mode, or MODE_INVALID on error.
int OpenCMISS::Zinc::Graphicssamplingattributes::getLocation ( int  valuesCount,
double *  valuesOut 
)
inline

Gets the location in the element chart where a point is sampled in mode CMZN_ELEMENT_POINT_SAMPLING_MODE_SET_LOCATION. Up to 3 values can be returned.

Parameters
valuesCountThe size of the valuesOut array.
valuesOutArray to receive location.
Returns
OpenCMISS::Zinc::OK on success, otherwise OpenCMISS::Zinc::ERROR_ARGUMENT.
bool OpenCMISS::Zinc::Graphicssamplingattributes::isValid ( ) const
inline

Check if this is a valid Graphicssamplingattributes object.

Returns
Status True if object is valid, false otherwise.
int OpenCMISS::Zinc::Graphicssamplingattributes::setDensityField ( const Field densityField)
inline

Sets the scalar field specifying the density of points sampled from elements when used with CELL_POISSON sampling mode. The density is applied per unit volume/area/length, depending on dimension, evaluated at cell centres.

See also
Graphicssamplingattributes::setElementPointSamplingMode
Parameters
densityFieldScalar density field to set.
Returns
OpenCMISS::Zinc::OK on success, otherwise OpenCMISS::Zinc::ERROR_ARGUMENT.
int OpenCMISS::Zinc::Graphicssamplingattributes::setElementPointSamplingMode ( Element::PointSamplingMode  samplingMode)
inline

Set the mode for sampling points in elements. The default element point sampling mode is CELL_CENTRES.

Parameters
samplingModeThe element point sampling mode to set.
Returns
OpenCMISS::Zinc::OK on success, otherwise OpenCMISS::Zinc::ERROR_ARGUMENT.
int OpenCMISS::Zinc::Graphicssamplingattributes::setLocation ( int  valuesCount,
const double *  valuesIn 
)
inline

Sets the location in the element chart where a point is sampled in mode CMZN_ELEMENT_POINT_SAMPLING_MODE_SET_LOCATION. Up to 3 values can be set, with 0 assumed for additional chart coordinates.

See also
Graphicssamplingattributes::setElementPointSamplingMode
Parameters
valuesCountThe size of the valuesIn array.
valuesInArray containing element location to set.
Returns
OpenCMISS::Zinc::OK on success, otherwise OpenCMISS::Zinc::ERROR_ARGUMENT.

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