OpenCMISS-Zinc 3.0.0 Release C++ API Documentation
 All Classes Namespaces Files Functions Typedefs Enumerations Enumerator Pages
Public Member Functions | List of all members
OpenCMISS::Zinc::GlyphAxes Class Reference

A specialised glyph type which renders 3-D axes. More...

#include <glyph.hpp>

Inheritance diagram for OpenCMISS::Zinc::GlyphAxes:
OpenCMISS::Zinc::Glyph

Public Member Functions

 GlyphAxes (cmzn_glyph_axes_id axes_id)
 
double getAxisWidth ()
 
int setAxisWidth (double axisWidth)
 
char * getAxisLabel (int axisNumber)
 
int setAxisLabel (int axisNumber, const char *label)
 
Material getAxisMaterial (int axisNumber)
 
int setAxisMaterial (int axisNumber, const Material &material)
 
- Public Member Functions inherited from OpenCMISS::Zinc::Glyph
 Glyph (cmzn_glyph_id in_glyph_id)
 
 Glyph (const Glyph &glyph)
 
Glyphoperator= (const Glyph &glyph)
 
bool isValid () const
 
cmzn_glyph_id getId () const
 
char * getName ()
 
int setName (const char *name)
 
bool isManaged ()
 
int setManaged (bool value)
 
GlyphAxes castAxes ()
 
GlyphColourBar castColourBar ()
 

Additional Inherited Members

- Public Types inherited from OpenCMISS::Zinc::Glyph
enum  RepeatMode {
  REPEAT_MODE_INVALID = CMZN_GLYPH_REPEAT_MODE_INVALID, REPEAT_MODE_NONE = CMZN_GLYPH_REPEAT_MODE_NONE, REPEAT_MODE_AXES_2D = CMZN_GLYPH_REPEAT_MODE_AXES_2D, REPEAT_MODE_AXES_3D = CMZN_GLYPH_REPEAT_MODE_AXES_3D,
  REPEAT_MODE_MIRROR = CMZN_GLYPH_REPEAT_MODE_MIRROR
}
 
enum  ShapeType {
  SHAPE_TYPE_INVALID = CMZN_GLYPH_SHAPE_TYPE_INVALID, SHAPE_TYPE_NONE = CMZN_GLYPH_SHAPE_TYPE_NONE, SHAPE_TYPE_ARROW = CMZN_GLYPH_SHAPE_TYPE_ARROW, SHAPE_TYPE_ARROW_SOLID = CMZN_GLYPH_SHAPE_TYPE_ARROW_SOLID,
  SHAPE_TYPE_AXIS = CMZN_GLYPH_SHAPE_TYPE_AXIS, SHAPE_TYPE_AXIS_SOLID = CMZN_GLYPH_SHAPE_TYPE_AXIS_SOLID, SHAPE_TYPE_CONE = CMZN_GLYPH_SHAPE_TYPE_CONE, SHAPE_TYPE_CONE_SOLID = CMZN_GLYPH_SHAPE_TYPE_CONE_SOLID,
  SHAPE_TYPE_CROSS = CMZN_GLYPH_SHAPE_TYPE_CROSS, SHAPE_TYPE_CUBE_SOLID = CMZN_GLYPH_SHAPE_TYPE_CUBE_SOLID, SHAPE_TYPE_CUBE_WIREFRAME = CMZN_GLYPH_SHAPE_TYPE_CUBE_WIREFRAME, SHAPE_TYPE_CYLINDER = CMZN_GLYPH_SHAPE_TYPE_CYLINDER,
  SHAPE_TYPE_CYLINDER_SOLID = CMZN_GLYPH_SHAPE_TYPE_CYLINDER_SOLID, SHAPE_TYPE_DIAMOND = CMZN_GLYPH_SHAPE_TYPE_DIAMOND, SHAPE_TYPE_LINE = CMZN_GLYPH_SHAPE_TYPE_LINE, SHAPE_TYPE_POINT = CMZN_GLYPH_SHAPE_TYPE_POINT,
  SHAPE_TYPE_SHEET = CMZN_GLYPH_SHAPE_TYPE_SHEET, SHAPE_TYPE_SPHERE = CMZN_GLYPH_SHAPE_TYPE_SPHERE, SHAPE_TYPE_AXES = CMZN_GLYPH_SHAPE_TYPE_AXES, SHAPE_TYPE_AXES_123 = CMZN_GLYPH_SHAPE_TYPE_AXES_123,
  SHAPE_TYPE_AXES_XYZ = CMZN_GLYPH_SHAPE_TYPE_AXES_XYZ, SHAPE_TYPE_AXES_COLOUR = CMZN_GLYPH_SHAPE_TYPE_AXES_COLOUR, SHAPE_TYPE_AXES_SOLID = CMZN_GLYPH_SHAPE_TYPE_AXES_SOLID, SHAPE_TYPE_AXES_SOLID_123 = CMZN_GLYPH_SHAPE_TYPE_AXES_SOLID_123,
  SHAPE_TYPE_AXES_SOLID_XYZ = CMZN_GLYPH_SHAPE_TYPE_AXES_SOLID_XYZ, SHAPE_TYPE_AXES_SOLID_COLOUR = CMZN_GLYPH_SHAPE_TYPE_AXES_SOLID_COLOUR
}
 
- Protected Attributes inherited from OpenCMISS::Zinc::Glyph
cmzn_glyph_id id
 

Detailed Description

A specialised glyph type which renders 3-D axes.

A specialised glyph type which renders 3-D axes with arbitrary labels and selected glyph repeated on 3 axes.

Member Function Documentation

char* OpenCMISS::Zinc::GlyphAxes::getAxisLabel ( int  axisNumber)
inline

Get the label to be drawn at the end of the given axis.

Parameters
axisNumberThe axis number from 1 to 3.
Returns
Allocated string containing label, or NULL if none or error. Up to caller to free using cmzn_deallocate().
Material OpenCMISS::Zinc::GlyphAxes::getAxisMaterial ( int  axisNumber)
inline

Get the material an axis is drawn with.

Parameters
axisNumberThe axis number from 1 to 3.
Returns
Handle to material, or NULL/invalid handle if none or failed.
double OpenCMISS::Zinc::GlyphAxes::getAxisWidth ( )
inline

Gets the width of each axis relative to unit length.

Returns
The axis width, or 0.0 if error.
int OpenCMISS::Zinc::GlyphAxes::setAxisLabel ( int  axisNumber,
const char *  label 
)
inline

Set the label to be drawn at the end of the given axis.

Parameters
axisNumberThe axis number from 1 to 3.
labelThe label, or NULL for none.
Returns
Status OpenCMISS::Zinc::OK on success, otherwise OpenCMISS::Zinc::ERROR_ARGUMENT.
int OpenCMISS::Zinc::GlyphAxes::setAxisMaterial ( int  axisNumber,
const Material material 
)
inline

Set the material an axis is drawn with. Note if the material is NULL for any axis the default material for the graphics is used for that axis.

Parameters
axisNumberThe axis number from 1 to 3.
materialThe material, or NULL to use the default material from the graphics.
Returns
Status OpenCMISS::Zinc::OK on success, otherwise OpenCMISS::Zinc::ERROR_ARGUMENT.
int OpenCMISS::Zinc::GlyphAxes::setAxisWidth ( double  axisWidth)
inline

Sets the width of each axis relative to unit length. The default axis width is 0.1 i.e. 10% of the length and suitable for glyph 'axis' and 'axis_solid'.

Parameters
axisWidthThe new axis width. Must be non-negative.
Returns
Status OpenCMISS::Zinc::OK on success, otherwise OpenCMISS::Zinc::ERROR_ARGUMENT.

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