Application Programmer Interface (API)

The routines of the IRIS Explorer Application Programmer Interface (API).

• cxCollab collaboration class library
• cxConnDup copy a connection list structure
• cxConnEleGet return connections of one element from a connection list structure
• cxConnEleSet set the connections of one element in a connection list structure
• cxConnMaxInd determine the maximum one-based index of all connections in a connection list
• cxConnNew allocate a connection list structure
• cxConnPtrGet return all contents of a connection list structure
• cxConnPtrSet set all contents of a connection list structure
• cxConnRemap remove connections to a cleaned pyramid layer
• cxCoordCoordType return the representation type of lattice coordinates
• cxCoordDefaultNew create default index coordinates
• cxCoordDup duplicate coordinates
• cxCoordExtract extract coordinate values at a node
• cxCoordLen return the length of the coordinate array
• cxCoordNVarGet get number of coordinate variables
• cxCoordNVarSet set number of coordinate values
• cxCoordNew create new coordinate data structure
• cxCoordTransform apply a homogeneous transformation matrix to all coordinates
• cxCoordValsGet return pointer to coordinate values
• cxCoordValsSet set pointer to coordinate values
• cxDataAllocErrorClear - obsolete, see cxDataManAbortOnError
• cxDataAllocErrorGet - obsolete, see cxDataManAbortOnError
• cxDataCalloc allocate and clear space from IRIS Explorer data memory
• cxDataCheck check datatype at the current level of detail
• cxDataCheckErrorInfoDel delete a cxDataCheckErrorInfo structure
• cxDataCheckErrorInfoGet extract information from a cxDataCheckErrorInfo structure
• cxDataCheckErrorInfoMsgAppend append a null-terminated string to a cxDataCheckErrorInfo message buffer
• cxDataCheckErrorInfoNew create a new cxDataCheckErrorInfo structure
• cxDataCheckingSet create a vector of the given type
• cxDataDup duplicate data values
• cxDataErrorMsgGet return a character string describing a particular memory error
• cxDataFree release IRIS Explorer data memory
• cxDataInputsCheck check integrity of data on input ports
• cxDataMagicCheck check magic number of any data type
• cxDataMalloc allocate space from IRIS Explorer data memory
• cxDataManAbortOnError modify the error handling behaviour of the IRIS Explorer data allocation manager.
• cxDataMemBoundsCheck check data object for memory corruption
• cxDataNew create new data structure
• cxDataObjNew create a new data object of an arbitrary type
• cxDataOutputsCheck check integrity of data on output ports
• cxDataPrimSize return size of data primitive element
• cxDataPrimType return primitive data type
• cxDataRealloc change size of IRIS Explorer data memory block
• cxDataRefCntGet return data reference count
• cxDataRefDec decrement reference count of IRIS Explorer data type
• cxDataRefInc increment reference count of IRIS Explorer data type
• cxDataTypeNameGet return the data type name of the given data
• cxDataValsGet return pointer to data values
• cxDataValsSet set pointer to data values
• cxDimsProd compute total number of data or coordinate values in a lattice
• cxDimsSum compute the sum of a dimensions vector
• cxFilenameExpand create a complete pathname from a name with tildes, environment variables, etc
• cxFilenameIndexIncrement increment the integer cxFilenameExpand uses to replace %n
• cxFilenameIndexSet set the integer to replace %n in cxFilenameExpand
• cxFireASAP fire the module as soon as possible
• cxFireConnectsGet return the number of connections to the "Fire" port
• cxFireDataChanged check if the data on the "Fire" port is new
• cxFireDataChangedV check if the data on the "Fire" port is new
• cxGeneric interface routines for IRIS Explorer cxGeneric data structure
• cxGeoABGRAdd add packed color(s) to the current geometry object
• cxGeoBufferClose close a geometry buffer in preparation to output it
• cxGeoBufferPortSet Associate output port with current geometry buffer
• cxGeoBufferSelect select a buffer for recording geometry operations
• cxGeoColorAdd add color(s) to the current geometry object
• cxGeoComplexityAdd specify the level of rendering detail
• cxGeoConesDefine define a cone set object
• cxGeoCylindersDefine define a set of cylinders
• cxGeoDelete delete the current geometry object
• cxGeoFocus edit a previously defined object or transform
• cxGeoGridDefine create a grid geometry object
• cxGeoIdentity reset the transform on the current object
• cxGeoInit initialize IRIS Explorer geometry library
• cxGeoInventorDefine add an Inventor scene graph to output geometry
• cxGeoLabelAdd add a label to the current geometry object
• cxGeoLightModelAdd set the light model for the current geometry object
• cxGeoLinesDefine define a line set object
• cxGeoMatrixCat apply an arbitrary 4x4 transform to the current object
• cxGeoMemoryRefAdd record a shared memory buffer as part of a cxGeometry structure
• cxGeoNew create a new geometry buffer
• cxGeoNormalAdd add normals to a geometry object
• cxGeoOctreeDefine define an octree volume object
• cxGeoPatchDefine define a NURB spline patch
• cxGeoPlotBegin begins new plot
• cxGeoPlotColorSet set an attribute of the current plot using a color
• cxGeoPlotDataAdd adds a dataset of x and y values to the current plot
• cxGeoPlotDataColorSet use a color to set an attribute of the current dataset to be plotted
• cxGeoPlotDataFloatSet use a float to set an attribute of the current dataset to be plotted
• cxGeoPlotDataFocusSet sets a dataset in the current plot to be the current dataset
• cxGeoPlotDataOptionSet use an integer to set an attribute of the current dataset to be plotted
• cxGeoPlotDataRemove removes a set of x and y values from the current plot
• cxGeoPlotDataRemoveAll removes all of the datasets from the current plot
• cxGeoPlotDataStrSet use a string to set an attribute of the current dataset to be plotted
• cxGeoPlotDefine closes the current plot and passes it to the geometry buffer
• cxGeoPlotFloatSet set an attribute of the current plot using a float
• cxGeoPlotGetLastError returns last error associated with the current plot
• cxGeoPlotLegendAdd adds a legend to the current plot
• cxGeoPlotOptionSet set an attribute of the current plot using a integer
• cxGeoPlotStrSet set an attribute of the current plot using a string
• cxGeoPlotTextDefine adds a title to the current geometry buffer
• cxGeoPointsDefine define a point set object
• cxGeoPolysDefine define a polygon set object
• cxGeoReceive instantiate input geometry
• cxGeoReceiverNew create a new cxGeoReceiver object
• cxGeoRoot set the current object to the root object
• cxGeoRotate rotate the current geometry object
• cxGeoScale scale the current geometry object
• cxGeoSpheresDefine define a set of spheres
• cxGeoSplineDefine define a nurb spline
• cxGeoStyleAdd add a drawing style to the current geometry object
• cxGeoTextDefine define a new text object
• cxGeoTextureAdd adds a texture to the current geometry object
• cxGeoTextureCoordinate2Define define 2D texture coordinates
• cxGeoTranslate translate the current geometry object
• cxGeoTransparencyAdd add transparency to the current geometry object
• cxGeoTrisDefine define a triangle mesh object
• cxGeoXformPop end defining geometry objects in a transform group
• cxGeoXformPush create a group object
• cxGeometry interface routines for IRIS Explorer cxGeometry data structure
• cxHSVtoRGB convert color values from hue/saturation/value to red/green/blue
• cxInWdgtChoiceLabelMultiSet set a range of labels on a choice widget
• cxInWdgtChoiceLabelSet set the label of an item in a choice widget
• cxInWdgtDblMinMaxSet set the range of a double precision input parameter's widget
• cxInWdgtDblSet set the value of a double precision input parameter and widget
• cxInWdgtDisable disable a widget of a parameter port
• cxInWdgtEnable make a widget of a parameter port operational
• cxInWdgtHide make a widget of a parameter port invisible
• cxInWdgtLabelSet change the label on a widget
• cxInWdgtLongMinMaxSet set the range of a long input parameter's widget
• cxInWdgtLongSet set the value of a long input parameter and widget
• cxInWdgtMinMaxGet get the range of a double precision or long integer input parameter's widget
• cxInWdgtScrollListItemsDelete delete items listed in an array of character strings
• cxInWdgtScrollListItemsInsert insert items listed in an array of character strings into a list widget
• cxInWdgtScrollListItemsSel select a series of items in an list widget
• cxInWdgtScrollListItemsSelSet select and set a series of items in an list widget
• cxInWdgtScrollListItemsSet set an array of character strings to be the items in a list widget
• cxInWdgtShow make a widget of a parameter port visible
• cxInWdgtStrSet set the value of a string input parameter and widget
• cxInputAdd register a file descripter for monitoring
• cxInputConnectsGet return the number of connections to an input port
• cxInputDataChanged check if the data on an input port has changed
• cxInputDataChangedV check if the data on an input port has changed
• cxInputDataConnIDGet get a unique connection identifier for data
• cxInputDataConnIDGetV get a unique connection identifier for data
• cxInputDataGet retrieve the data on a particular input port
• cxInputDataGetV retrieve the data on a particular input port
• cxInputDataRelease remove data from an input port
• cxInputDataReleaseV remove data from an input port
• cxInputPortCount get a count of the number of input ports
• cxInputPortNames get a list of the input port names
• cxInputPortOpen convert a port name to a port descriptor
• cxInputRemove remove a registered file descriptor
• cxInputTypeGet determine the allowable data type of a particular input port
• cxLatCoordExtract extract coordinate values at a node
• cxLatCoordNew create a lattice with coordinates and no data
• cxLatDataNew create a lattice with data and no coordinates
• cxLatDescGet extract descriptive information about a lattice
• cxLatDup duplicate a lattice, optionally duplicating data and coordinates
• cxLatNew create a lattice with data and coordinates
• cxLatPtrGet extract pointers to lattice data and coordinate
• cxLatPtrSet set lattice data and coordinate pointers
• cxLatRootDup duplicate a lattice without data or coordinates
• cxLatRootNew create a lattice with no data and no coordinates
• cxLattice interface routines for IRIS Explorer cxLattice data structure
• cxLookupCreate creates a lookup table for subsequent interpolation of lattice values
• cxLookupDestroy deletes a lookup table created by cxLookupCreate
• cxLookupIndex interpolate into lattice index space at one coordinate location
• cxLookupIndexV interpolate into lattice index space at a vector of coordinate location
• cxLookupInterp interpolate lattice data at one coordinate location
• cxLookupInterpV interpolate lattice data at a vector of coordinate locations
• cxLoopBreak Force loop controller to terminate loop
• cxLoopControlArc Determine whether a connection carries loop data
• cxLoopCtlr Determine whether a module is an active loop controller
• cxLoopIteration Determine whether module is firing from a loop iteration
• cxMemBoundsCheck check the memory bounds for an arbitrary area of data memory
• cxMemBoundsSet resize memory boundary information
• cxModAlert present an alert dialogue box to the user
• cxModExit terminates module execution
• cxModuleBaseNameGet return the base name of the module
• cxModuleExecTagValueSet set the current module control wrapper from within a compiled group using a module tag
• cxModuleInstanceNameGet return unique module instance name
• cxModuleNameGet return the name of the module
• cxModuleTagValueGet return a unique integer identifier for a module
• cxOutputConnectsGet return the number of connections from a particular output port
• cxOutputDataFlush transmit the data associated with an output port
• cxOutputDataFlushAll output all new data immediately
• cxOutputDataRelease remove a data object from an output port
• cxOutputDataSet attach a data object to an output port
• cxOutputNoSync prevent data being output on the "Firing Done" or "Loop Ended" ports
• cxOutputPortCount get a count of the number of output ports
• cxOutputPortNames get a list of the output port names
• cxOutputPortOpen Get a handle for a port
• cxOutputPortSharedXferGet query whether an output port supports shared geometry transfer
• cxOutputSendNow output data on a single port immediately
• cxOutputTypeGet determine the allowable data type of a particular output port
• cxParamColorFloatGet convert a string color parameter into floating point RGBA
• cxParamColorFloatSet convert floating point color values into a string color parameter
• cxParamColorPackedGet convert a string color parameter into a packed integer format
• cxParamColorPackedSet convert a packed color value into a color parameter
• cxParamDblGet return parameter value as double
• cxParamDblSet set parameter value to a double value
• cxParamDoubleNew create an IRIS Explorer parameter of type double
• cxParamDup duplicate a parameter
• cxParamLongGet return parameter value as a long
• cxParamLongNew create a parameter of type long
• cxParamLongSet set parameter to an integer value
• cxParamNew create parameter data type
• cxParamPathnameGet expand a parameter string value as a Unix path name
• cxParamStrGet returns parameter value as a string
• cxParamStrNew create a parameter of type string
• cxParamStrSet set parameter to a string value
• cxParamTypeGet return parameter type
• cxParamTypeSet set parameter type
• cxParameter interface routines for IRIS Explorer cxParameter data structure
• cxPick interface routines for IRIS Explorer cxPick data structure
• cxPickGet get information out of pick data type
• cxPickHitConeGet get detail information about a pick hit on a cone
• cxPickHitConeSet set a cone hit in a pick structure
• cxPickHitCylinderGet get detail information about a pick hit on a cylinder
• cxPickHitCylinderSet set a cylinder hit in a pick structure
• cxPickHitFaceGet get detailed hit information about a picked face
• cxPickHitFaceSet set a polygon face hit in a pick structure
• cxPickHitGet get detailed information about a hit from a pick
• cxPickHitLineGet get detail pick information on a line hit
• cxPickHitLineSet set a line segment hit in a pick structure
• cxPickHitPointGet get detail information about a pick hit on a point
• cxPickHitPointSet set a point hit in a pick structure
• cxPickNew create a new pick object
• cxPickSet initialize hit structures in a cxPick structure
• cxPyrActive flag as active/inactive the elements at a specified pyramid layer
• cxPyrActiveList list the active elements at a specified pyramid layer
• cxPyrActiveListNext list the active elements at the next lower pyramid layer
• cxPyrActiveNext flag as active/inactive the elements at the next lower pyramid layer
• cxPyrActivePrev flag as active/inactive the elements at the next higher pyramid layer
• cxPyrClean removes unreferenced items from a pyramid
• cxPyrCompress makes a compressed copy of a pyramid structure
• cxPyrConCompare compare two set of vertices based on the equivalence type
• cxPyrDictCompress compresses the reference element pyramids in a pyramid dictionary
• cxPyrDictDefault create default finite element pyramid dictionary
• cxPyrDictLookup determine the index of a pyramid in a finite element pyramid dictionary
• cxPyrDup makes a copy of a pyramid structure
• cxPyrDupExpand makes an uncompressed copy of a pyramid structure
• cxPyrEleDupExpand makes an uncompressed copy of an element in a pyramid structure
• cxPyrExpand makes an uncompressed pyramid structure
• cxPyrGet returns a pointer to the base lattice and the number of layers from a pyramid
• cxPyrLayerClean removes selected items from one layer of a pyramid
• cxPyrLayerGet returns the lattice and connection list from one layer of a pyramid
• cxPyrLayerSet replaces the lattice and connection list in one layer of a pyramid
• cxPyrLayerSkip returns a cxConnection structure relating two non-adjacent
• cxPyrMerge selectively merges duplicated elements in layer of a pyramid
• cxPyrNew allocates a pyramid structure
• cxPyrRefIndexGet find the pyramid dictionary index of a compressed pyramid element
• cxPyrSet replaces the base lattice in a pyramid
• cxPyrVertOrder list the vertices on a pyramid face in their natural order of traversal
• cxPyramid interface routines for IRIS Explorer cxPyramid data structure
• cxQmeshCoords interpolate coordinates from grid points to cell centers
• cxQmeshData interpolate data values from grid points to cell centers
• cxQmeshNextInd step through triangle vertices in a quadrilateral mesh
• cxQmeshNumPoints return the number of points in a quadrilateral mesh with interpolated centers
• cxQmeshNumTris return the number of triangles in a quadrilateral mesh with interpolated centers
• cxQmeshTris generate polygon vertex indexing to create a quadrilateral mesh using cell centers
• cxRGBtoHSV convert color values from red/green/blue to hue/saturation/value
• cxScriptCommand Send an IRIS Explorer script command to the U/I
• cxSoColorIndex surface color index node using shared memory field classes
• cxSoCoordinate3 coordinate point node using shared memory field classes
• cxSoCoordinate4 rational coordinate point node using shared memory field classes
• cxSoIndexedFaceSet indexed polygonal face shape node using shared memory field classes
• cxSoIndexedLineSet indexed polyline shape node using shared memory field classes
• cxSoIndexedShape abstract base class for all indexed vertex-based shapes using shared memory field classes
• cxSoIndexedTriangleStripSet indexed triangle strip set shape node using shared memory field classes
• cxSoMFColor multiple-value field containing any number of RGB colors
• cxSoMFFloat multiple-value field containing any number of floating point values
• cxSoMFInt32 multiple-value field containing any number of int32_t integers
• cxSoMFUInt32 multiple-value field containing any number of uint32_t integers
• cxSoMFVec3f multiple-value field containing any number of three-dimensional vectors
• cxSoMFVec4f multiple-value field containing any number of four-dimensional vectors
• cxSoMaterial surface material definition node using shared memory field classes
• cxSoNormal node that defines surface normals for shapes using shared memory field classes
• cxSoPackedColor node that defines base colors using packed representation using shared memory field classes
• cxSoVertexProperty abstract base class for all vertex-based shapes using shared memory field classes
• cxSoVertexShape abstract base class for all vertex-based shapes using shared memory field classes
• cxTimerAdd register an interval timer
• cxTimerRemove remove an interval timer
• cxTypeMismatchConnectMsg return a suitably formatted string describing erroneous module connection
• cxTypeMismatchMsg return a suitably formatted string describing erroneous data
• cxTypeMismatchPortMsg return a suitably formatted string describing erroneous data
• cxTypeMismatchPtrMsg return a suitably formatted string describing erroneous pointer data
• cxUnkDup create a duplicate of unknown type
• cxUnkGet get information about unknown data structure
• cxUnkNew create unknown data type
• cxUnkSet set size and location of unknown data vector
• cxUnknown interface routines for IRIS Explorer cxUnknown data structure
• cxUserSupplied user function within a module
• cxVecClipGet gets coercion clipping state used by the Module Data Wrapper
• cxVecClipSet sets coercion clipping state used by the Module Data Wrapper
• cxVecCoerce converts a vector of data from one primitive type to another
• cxVecDel delete a vector of elements
• cxVecDelStr delete a vector of elements of scalar or string type
• cxVecDup create a duplicate of a given vector
• cxVecNew create a vector of the given type
• cxXtAreaAttach attach a widget hierarchy to a control panel drawing area
• cxXtAreaCallbackAdd add a callback function to the drawing area widget
• cxXtAreaInitialize create a widget hierarchy for use in a control panel
• cxXtAreaResize update the size of a control panel drawing area widget hierarchy