*vis_MarkBegin - create an instance of a Mark object vis_MarkEnd - destroy an instance of a Mark object vis_MarkError - return Mark object error flag
vis_MarkPnt - draw point marker vis_MarkPntIntersectLine - compute closet point to input line vis_MarkPntIntersectPoint - compute closet point to input point vis_MarkPntTrav - traverse and draw a group of point markers vis_MarkPolyPointData - draw markers on PolyPointData primitive vis_MarkSetMask - set component drawing masks GetMask - get component drawing masks vis_MarkSetObject - set pointers to attribute objects. vis_MarkSetDirCos - set user direction cosine matrix GetDirCos - get user direction cosine matrix vis_MarkSetParam - set parameters for marker visualization vis_MarkScalar - draw scalar vis_MarkVector - draw vector vis_MarkTensor - draw tensor vis_MarkVectorCompute - compute vector values and annotation locations vis_MarkTensorCompute - compute tensor values and annotation locations vis_MarkTensorMaxShear - compute tensor maximum shear values vis_MarkTensorPrincipal - compute tensor principal values vis_MarkTrav - traverse and draw a group of markers
If size is mapped to field value, then the field value minimum and maximum set in the Levels object using vis_LevelsSetMinMax are used to compute the maximum absolute value of the field value which is mapped to maximum marker Size as specified by the VisContext attribute object. By default, the size is linearly mapped to field value.
size = Size * field_value/maxabs_valueThe function vis_MarkSetParamf may be used to set a decay factor to control the size mapping as shown below.
size = Size * (field_value/absmax_value) ** decayThe markers may be sized to a world coordinate or device coordinate size. The type of sizing is specified by the SizeType visualization context component. If SizeType is set to VIS_SIZEDEVICE then the XfmMatrix, ProjMatrix and Viewport visualization context components should be set to reflect the current state of the underlying graphics device.
Scalar markers consist of a single 2D or 3D icon such as a triangle, square, tetrahedron or sphere. The size and/or color of a scalar marker may be mapped to the magnitude of a scalar quantity at a point. The size of a scalar marker is loosely defined as the "diameter" of the marker. Scalar markers are drawn centered on the point at which they are located.
A scalar marker is not drawn at a point if the marker size is mapped to field value and the scalar field value is zero. Figure 5-1 illustrates a flat shaded spherical scalar marker drawn with medium refinement. Scalar markers use the following scalar VisContext components. Point markers drawn with vis_MarkPnt are designed to mark points without reference to a field value.
If marker size is mapped to field value, a component vector marker is not drawn at a point if the component field value is zero, a resultant vector marker is not drawn if the vector field magnitude is zero.
If vector components are drawn using a VectorType of VIS_VECTORLINE, by default the heads of each component vector in the x,y and z directions lie in the x-y, y-z and z-x planes respectively of the coordinate system in which they are defined. If the viewplane Project visualization component is set to VIS_ON, then the heads of each vector are drawn in the viewplane defined by the current modelview matrix. The viewplane is defined by the current modelview matrix visualization component, XfmMatrix.
Figure 5-1 illustrates a flat shaded cylindrical vector marker drawn with medium refinement. Vector markers use the following vector VisContext components.
If marker size is mapped to field value, a component tensor box is not drawn at a point if all the component field values are zero, a principal tensor box is not drawn if all the principal values are zero, component direct and shear arrows are not drawn if the component value is zero, and principal direct arrows are not drawn if the principal value is zero.
Figure 5-2 illustrates two types of tensor markers. The left marker uses an ellipsoid tensor box and is aligned to the principal directions of the tensor. The right marker is oriented to the axes of the defining coordinate system of the tensor and features vectors representing both the direct and shear components of the tensor. Tensor markers use the following tensor VisContext components.
*vis_MarkBegin - create an instance of a Mark object
vis_Mark *vis_MarkBegin ()
None
Destroy an instance of a Mark object using
void vis_MarkEnd (vis_Mark *mark)
Return the current value of a Mark object error flag using
Vint vis_MarkError (vis_Mark *mark)
vis_MarkPnt - draw point markers
void vis_MarkPnt (vis_Mark *mark,
Vint npts,
Vfloat x[][3])
mark Pointer to Mark object. npts The number of points at which to draw point markers x Array of npts locations.
None
vis_MarkPntIntersectLine,vis_MarkPntIntersectPoint - compute point of intersection
void vis_MarkPntIntersectLine (vis_Mark *mark,
Vint npts,
Vfloat x[][3],
Vfloat xl[2][3],
Vint *ipt,
Vfloat xr[3],
Vfloat xd[3],
Vint *status)
void vis_MarkPntIntersectPoint (vis_Mark *mark,
Vint npts,
Vfloat x[][3],
Vfloat xp[3],
Vint *ipt,
Vfloat xr[3],
Vfloat xd[3],
Vint *status)
mark Pointer to Mark object. npts The number of points at which to test point markers x Array of npts locations. xl End points of intersecting line xp Intersecting point
ipt Index of point closest to intersecting point or line.
1 <= ipt <= npts
xr Coordinates of closest point marker.
xd Vector from xr to point or closest point on line
status Intersection status
The case that the magnitude of xd is zero implies that the intersecting point or line actually intersected the tesselated marker. This will generally only occur in the case of an intersecting line if the marker has been drawn in a 3D filled marker type. If more than one true point of intersection is determined, the point closest to the first endpoint of the intersecting line is returned.
The status variable is returned as unity if the length of vector xd is less than the DistTol element of the visualization context and zero otherwise.
Note that the basic intersection testing is performed on the graphics primitives used to represent the marker. This means, for example, that if a spherical marker type has been specified in the VisContext attribute object, then intersection testing will be performed using the graphics polygons which result from tesselating the marker into a sphere. In this way the intersection testing is performed upon the actual graphics primitives used to visually represent the marker on the graphics display.
vis_MarkPntTrav - traverse and draw a group of point markers
void vis_MarkPntTrav (vis_Mark *mark,
vis_Group *group)
mark Pointer to Mark object. group Pointer to Group object of nodes or elements.
None
vis_MarkPolyPointData - draw markers on PolyPointData primitive
void vis_MarkPolyPointData (vis_Mark *mark,
Vint npts,
Vfloat x[][3],
Vint nrws, Vfloat d[])
mark Pointer to Mark object. npts Number of vertex points x Vertex world coordinates nrws Number of values in d vector d Array of field values.
None
vis_MarkSetMask - set component drawing masks
void vis_MarkSetMask (vis_Mark *mark,
Vint mask[])
mark Pointer to Mark object.
mask Vector of component drawing masks.
=VIS_OFF Turn component drawing mask off
=VIS_ON Turn component drawing mask on
None
For scalar markers, the first mask, mask[0], toggles the drawing of a scalar marker.
For vector markers, the first three masks, mask[0], mask[1] and mask[2], toggle the drawing of the x,y and z components respectively of a vector marker. The first mask, mask[0], toggles the drawing of a resultant vector marker.
For tensor markers, the first six masks, mask[0], through mask[5], toggle the drawing of the xx,yy,zz,xy,yz and zx components respectively of a tensor marker. The first three masks, mask[0], mask[1] and mask[2], toggle the drawing of the min,mid and max principal values respectively of a tensor marker. For tensor markers drawn in maximum shear directions, the first six masks mask[0], through mask[5], toggle the drawing of the xx,yy,zz,xy,yz and zx components respectively of a tensor marker. The maximum shear is the zx component. The yy component is the mid principal.
Get drawing mask as an output argument using
void vis_MarkGetMask (vis_Mark *mark,
Vint mask[])
vis_MarkSetObject - set pointers to attribute objects
void vis_MarkSetObject (vis_Mark *mark,
Vint objecttype,
Vobject *object)
mark Pointer to Mark object.
objecttype The name of the object type to be set.
=VGL_DRAWFUN DrawFun object
=VIS_COLORMAP ColorMap object
=VIS_GRIDFUN GridFun object
=VIS_IDTRAN_COLOR IdTran color map index object
=VIS_IDTRAN_DATAINDEX IdTran data index object
=VIS_ISOCLIP IsoClip object
=VIS_LEVELS Levels object
=VIS_VISCONTEXT VisContext object for all markers
=VIS_VISCONTEXT_SCALAR VisContext object for scalar markers
=VIS_VISCONTEXT_VECTOR VisContext object for vector markers
=VIS_VISCONTEXT_TENSOR VisContext object for tensor markers
object Pointer to the object to be set.
None
If an IsoClip attribute object is set then isosurface clipping is activated. To deactivate isosurface clipping, set a NULL IsoClip object pointer.
The GridFun object is only used by vis_MarkTrav and vis_MarkPntTrav. The IdTran object is only used by vis_MarkPntTrav.
vis_MarkSetDirCos - set user defined direction cosine matrix
void vis_MarkSetDirCos (vis_Mark *mark,
Vfloat tm[3][3])
mark Pointer to Mark object.
tm Direction cosine matrices indicating the
coordinate system in which a vector or tensor is
expressed.
None
Given that X',Y' and Z' are three orthonormal vectors indicating the direction of the local coordinate axes in the global coordinate system (x,y,z), then the direction cosine matrix, tm for this local coordinate system is defined as:
tm[0][0] = X'x tm[0][1] = X'y tm[0][2] = X'z
tm[1][0] = Y'x tm[1][1] = Y'y tm[1][2] = Y'z
tm[2][0] = Z'x tm[2][1] = Z'y tm[2][2] = Z'z
Get drawing tm as an output argument using
void vis_MarkGetDirCos (vis_Mark *mark,
Vfloat tm[3][3])
vis_MarkSetParam - set parameters for marker visualization
void vis_MarkSetParamf (vis_Mark *mark,
Vint ptype,
Vfloat fparam)
mark Pointer to Mark object.
ptype Parameter type to set.
=MARK_DECAY Set sizing decay parameter
fparam Specifies the float value that ptype will be set to.
None
vis_MarkScalar,vis_MarkVector,vis_MarkTensor - draw markers
void vis_MarkScalar (vis_Mark *mark,
Vint npts,
Vfloat s[],
Vfloat x[][3])
void vis_MarkVector (vis_Mark *mark,
Vint npts,
Vfloat s[][3],
Vfloat x[][3])
void vis_MarkTensor (vis_Mark *mark,
Vint npts,
Vfloat s[][6],
Vfloat x[][3])
mark Pointer to Mark object.
npts The number of points at which to draw scalar, vector or
tensor markers.
s Array of npts scalar, vector or tensor field values.
x Array of npts locations.
None
vis_MarkVectorCompute,vis_MarkTensorCompute - compute vector and tensor markers
void vis_MarkVectorCompute (vis_Mark *mark,
Vfloat s[3],
Vfloat x[3],
Vfloat sc[],
Vfloat xc[][3])
void vis_MarkTensorCompute (vis_Mark *mark,
Vfloat s[6],
Vfloat x[3],
Vfloat sc[],
Vfloat xc[][2][3])
mark Pointer to Mark object. s Array of vector or tensor field values at a point x Point location.
sc Array of computed vector or tensor field values at a point xc Array of annotation locations.
In addition compute the annotation location of each drawn vector of the vector or tensor marker. For example if components of a vector are displayed, there are three vectors drawn to represent each component of the vector. In this case three annotation locations are computed and returned in global coordinates in array xc. An annotation location is a suitable place to draw a value or any other annotation glyph which describes a vector component. For vector markers, three locations are returned for vector components and one value for vector resultants. For tensor markers, twelve locations are returned for tensor components (two times six component vectors), and six values for tensor principal values (two times three principal vectors).
vis_MarkTensorPrincipal - compute tensor principal values
void vis_MarkTensorPrincipal (vis_Mark *mark,
Vfloat s[6],
Vfloat pv[3],
Vfloat tm[3][3])
void vis_MarkTensorPrincipaldv (vis_Mark *mark,
Vdouble s[6],
Vdouble pv[3],
Vdouble tm[3][3])
mark Pointer to Mark object. s Array of tensor field values at a point
pv Array of computed principal values tm Direction cosine matrices of principal directions
vis_MarkTensorMaxShear - compute tensor max shear values
void vis_MarkTensorMaxShear (vis_Mark *mark,
Vfloat s[6],
Vfloat ms[6],
Vfloat tm[3][3])
void vis_MarkTensorMaxSheardv (vis_Mark *mark,
Vdouble s[6],
Vdouble ms[6],
Vdouble tm[3][3])
mark Pointer to Mark object. s Array of tensor field values at a point
pv Array of computed principal values tm Direction cosine matrices of principal directions
vis_MarkTrav - traverse and draw a group of markers
void vis_MarkTrav (vis_Mark *mark,
vis_State *state,
vis_Group *group)
mark Pointer to Mark object.
state Pointer to State object of node or element data
group Pointer to Group object of nodes or elements.
If NULL, then all nodes or elements are assumed.
None
If color mapping is turned off, the markers are drawn with the constant color specified in the visualization context unless an IdTran attribute object is set which contains a color map index for each entity. If a VIS_IDTRAN_DATAINDEX IdTran attribute object has been set then a DataIndex drawing function is called with the value contained in the IdTran object prior to drawing the markers for an entity.
The underlying model information is accessed using the GridFun attribute object.
*vis_ValueBegin - create an instance of a Value object vis_ValueEnd - destroy an instance of a Value object vis_ValueError - return Value object error flag
vis_ValueSetObject - set pointers to attribute objects. vis_ValueInt - draw integer scalar value vis_ValueIntTrav - traverse and draw a group of integer values vis_ValuePolyPointData - draw values on PolyPointData primitive vis_ValueScalar - draw scalar value vis_ValueVector - draw vector values vis_ValueTensor - draw tensor values vis_ValueMatrix - draw general tensor values vis_ValueTrav - traverse and draw a group of values
Value displays may be drawn for scalar, vector, symmetric tensor or general tensor values in three dimensions. See section VisTools, Mathematical Data Types for a description of ordering conventions for the components of vectors, tensors and general tensors. The functions for drawing these values are vis_ValueScalar, vis_ValueVector, vis_ValueTensor and vis_ValueMatrix respectively. For vector values there is an option to draw the magnitude of the vector. For all tensor type values there is an option to draw the principal values as a column vector or the tensor component values in the directions of maximum shear. The maximum shear directions are oriented such that the y direction is the mid principal value and the z direction is in the direction of maximum For symmetric tensors the principal values are always real and are ordered from minimum to maximum value. For general tensors the eigenvalues may be all real or they may consist of a single real and a complex conjugate pair. If a complex conjugate pair exists, the first value of the column vector is the real part of the complex conjugate pair, the second value is the imaginary part followed by the letter "i" and the third value is the real eigenvalue.
Numerical values may be expressed in an integer, fixed floating point or scientific floating point format. Value displays are designed to remain perpendicular to the viewer while the value anchor point is positioned arbitrarily in 3D global coordinate space. The value display is anchored by its bottom left hand corner. A single VisContext object is required to set the visualization context for the values themselves, the brackets and the background components of the value display. Values are drawn in a bracket matrix format. The brackets are drawn in a constant color and line width using a solid line style. The background of the value display is drawn with a constant color and transparency. Figures 5-3, 5-4 and 5-5 illustrate scalar, vector, tensor and general tensor value displays with brackets. Note that in Figure 5-5 the eigenvalues of the general tensor contain a complex conjugate pair. The component values of the general tensor have been drawn using VIS_GFORMAT. The numerical values are drawn using the following value VisContext components.
*vis_ValueBegin - create an instance of a Value object
vis_Value *vis_ValueBegin ()
None
Destroy an instance of a Value object using
void vis_ValueEnd (vis_Value *value)
Return the current value of a Value object error flag using
Vint vis_ValueError (vis_Value *value)
vis_ValueInt - draw integer scalar values
void vis_ValueInt (vis_Value *value,
Vint npts,
Vint is[],
Vfloat x[][3])
value Pointer to Value object. npts The number of points at which to draw scalar values. is Array of npts integer scalar field values. x Array of npts locations.
None
vis_ValueIntTrav - traverse and draw a group of integer values
void vis_ValueIntTrav (vis_Value *value,
vis_IdTran *idtran,
vis_Group *group)
value Pointer to Value object. idtran Pointer to IdTran object of node or element ids group Pointer to Group object of nodes or elements.
None
The underlying model information is accessed using the GridFun attribute object. If an IdTran color map index attribute object is set, then each value is drawn in the color specified by the color map index.
vis_ValueSetObject - set pointers to attribute objects
void vis_ValueSetObject (vis_Value *value,
Vint objecttype,
Vobject *object)
value Pointer to Value object.
objecttype The name of the object type to be set.
=VGL_DRAWFUN DrawFun object
=VIS_COLORMAP ColorMap object
=VIS_GRIDFUN GridFun object
=VIS_IDTRAN_COLOR IdTran color map index object
=VIS_IDTRAN_DATAINDEX IdTran data index object
=VIS_ISOCLIP IsoClip object
=VIS_LEVELS Levels object
=VIS_TRANSMAP TransMap object
=VIS_VISCONTEXT VisContext object
object Pointer to the object to be set.
None
If an IsoClip attribute object is set then isosurface clipping is activated. To deactivate isosurface clipping, set a NULL IsoClip object pointer.
The GridFun object is only used by vis_ValueTrav and vis_ValueIntTrav. The IdTran object is only used by vis_ValueIntTrav.
vis_ValuePolyPointData - draw values on PolyPointData primitive
void vis_ValuePolyPointData (vis_Value *value,
Vint npts,
Vfloat x[][3],
Vint nrws, Vfloat d[])
value Pointer to Value object. npts Number of vertex points x Vertex world coordinates nrws Number of values in d vector d Array of field values.
None
vis_ValueScalar,vis_ValueVector,vis_ValueTensor,vis_ValueMatrix - draw values
void vis_ValueScalar (vis_Value *value,
Vint npts,
Vfloat s[],
Vfloat x[][3])
void vis_ValueVector (vis_Value *value,
Vint npts,
Vfloat s[][3],
Vfloat x[][3])
void vis_ValueTensor (vis_Value *value,
Vint npts,
Vfloat s[][6],
Vfloat x[][3])
void vis_ValueMatrix (vis_Value *value,
Vint npts,
Vfloat s[][9],
Vfloat x[][3])
value Pointer to Value object.
npts The number of points at which to draw scalar, vector,
tensor or general tensor values.
s Array of npts scalar, vector, tensor or general tensor
field values.
x Array of npts locations.
None
vis_ValueTrav - traverse and draw a group of values
void vis_ValueTrav (vis_Value *value,
vis_State *state,
vis_Group *group)
value Pointer to Value object.
state Pointer to State object of node or element data
group Pointer to Group object of nodes or elements.
If NULL, then all nodes or elements are assumed.
None
If color mapping is turned off, the values are drawn with the constant color specified in the visualization context unless an IdTran attribute object is set which contains a color map index for each entity. If a VIS_IDTRAN_DATAINDEX IdTran attribute object has been set then a DataIndex drawing function is called with the value contained in the IdTran object prior to drawing the values for an entity.
The underlying model information is accessed using the GridFun attribute object.