FLDget_poly_connect

Synopsis

get/set the poly connectivity list of one cell_set within a Cells Grid


int FLDget_poly_connect (
OMobj_id cell_set,
int **poly_conn_array,
int *size,
int mode);

int FLDset_poly_connect (
OMobj_id cell_set,
int *node_conn_array,
int size,
int mode);

Description

These routines get/set the poly connectivity array (poly_connect_list) within one cell_set array element in a Cells Grid.

The FLDget_poly_connect routine can be used for both getting and setting the node_connect_list array. When setting with a "get" routine (mode = OM_GET_ARRAY_WR or OM_GET_ARRAY_RW), it returns a pointer to a pointer to a pre-allocated array, and the developer just needs to fill in the values.

Parameters

OMobj_id cell_set

The OMobj_id of one cell_set array element within a Cells Grid, as returned by the FLDget_cell_set routine.

int **poly_conn_array
int *poly_conn_array

In FLDget_poly_connect, poly_conn_array is the address of a pointer to integers; upon return, *poly_conn_array will be filled in with the poly connectivity list. Call ARRfree() on this pointer when you are done using it.

In FLDset_poly_connect, poly_conn_array is the address of an array from which the poly connectivity list will be copied.

int *size
int size

In FLDget_poly_connect, *size is a pointer to an integer in which the size of the poly connectivity array is returned.

In FLDset_poly_connect, size is an integer that sets the size of the poly connectivity array.

"size" is the number of elements in the array irrespective of type.

int mode

An integer constant that establishes the access mode for the array subobject. Constants for the possible values are defined in avs/om.h as follows.

For FLDset_poly_connect:

Mode

 

Value

 

Meaning

 

OM_SET_ARRAY_COPY

0

Copy the array into the Object Manager

OM_SET_ARRAY_FREE

1

If possible, do not copy the array. Instead, set the object's array pointer to poly_conn_array. AVS/Express copies the array anyway if the function is running in an external process or if data type conversion is required.

AVS/Express manages the array and will determine when the array can be freed.

You must allocate space for the array with a call to ARRalloc.

OM_SET_ARRAY_STATIC

2

If possible, do not copy the array. Instead, set the object's array pointer to poly_conn_array. AVS/Express copies the array anyway if the function is running in an external process or if data type conversion is required.

AVS/Express does not manage the array. You must ensure that the array is valid for the life of the object or until the object replaces the array.

 

For FLDget_poly_connect:

Mode

 

Value

 

Meaning

 

OM_GET_ARRAY_RD

0

The program intends to read the array, but not write to it.

OM_GET_ARRAY_WR

1

The program intends to write to the array, completely replacing it, but not read it.

OM_GET_ARRAY_RW

2

The program intends to both read and write to the array.


COPY

3

The program requires a copy of the array for its own, private use (reading or writing).

 

Example

None available.

Related routines