FISH Functions

The type specifiers used in the FISH function signatures are given in the FISH Type Index section.

Building Blocks Block Functions

building_blocks.block.ablock(BB_BLOCK_PNT,BB_FACE_PNT) Get an attached block.
building_blocks.block.center(BB_BLOCK_PNT) Get the center point of a block.
building_blocks.block.check(BB_BLOCK_PNT) Get the validity of a block.
building_blocks.block.edge(BB_BLOCK_PNT,INT) Get a block edge.
building_blocks.block.face(BB_BLOCK_PNT,INT) Get a block face.
building_blocks.block.multiplier(BB_BLOCK_PNT) Get the block multiplier.
building_blocks.block.point(BB_BLOCK_PNT,INT) Get a block point.
building_blocks.block.size(BB_BLOCK_PNT) Get the number of block faces.

Building Blocks Face Functions

building_blocks.face.area(BB_FACE_PNT) Get the area of a face.
building_blocks.face.center(BB_FACE_PNT) Get the center point of a face.
building_blocks.face.check(BB_FACE_PNT) Get the validity of the face.
building_blocks.face.edge(BB_FACE_PNT,INT) Get an edge of a face.
building_blocks.face.flip(BB_FACE_PNT,INT) Get edge “flipped” status.
building_blocks.face.gridsizei(BB_FACE_PNT,BB_BLOCK_PNT) Get number of zones along the local “x” edge of...
building_blocks.face.gridsizej(BB_FACE_PNT,BB_BLOCK_PNT) Get number of zones along the local “y” edge of...
building_blocks.face.next.face(BB_FACE_PNT,INT) Get the next face in a list.
building_blocks.face.next.index(BB_FACE_PNT,INT) Get the index of the next face in a list.
building_blocks.face.point(BB_FACE_PNT,INT) Get a point of a face.
building_blocks.face.size(BB_FACE_PNT) Get the number of face edges.
building_blocks.face.toglobal(BB_FACE_PNT,VEC) Get the global coordinates of a point from local coordinates.
building_blocks.face.tolocal(BB_FACE_PNT,VEC) Get the local coordinates of a point from global coordinates.

Building Blocks Edge Functions

building_blocks.edge.center(BB_EDGE_PNT) Get the center point of an edge.
building_blocks.edge.cp.add(BB_EDGE_PNT,VEC) Add a control point to an edge.
building_blocks.edge.cp.delete(BB_EDGE_PNT,INT) Delete a control point on an edge.
building_blocks.edge.cp.localu(BB_EDGE_PNT,INT) Get a local edge coordinate of a control point.
building_blocks.edge.cp.point(BB_EDGE_PNT,INT) Get the 3D coordinates of a control point.
building_blocks.edge.cp.size(BB_EDGE_PNT) Get the number of control points on an edge.
building_blocks.edge.curve(BB_EDGE_PNT) Get edge curvature.
building_blocks.edge.direction(BB_EDGE_PNT) Get edge direction.
building_blocks.edge.grid.ratio(BB_EDGE_PNT) Get the ratio parameter of an edge.
building_blocks.edge.grid.ratio.isolate(BB_EDGE_PNT) Get the state of the ratio-isolate flag.
building_blocks.edge.grid.size(BB_EDGE_PNT) Get the number of zones along an edge.
building_blocks.edge.length(BB_EDGE_PNT) Get the length of an edge.
building_blocks.edge.next.edge(BB_EDGE_PNT,INT) Get the next edge in a list.
building_blocks.edge.next.index(BB_EDGE_PNT,INT) Get the index of the next edge in a list.
building_blocks.edge.point(BB_EDGE_PNT,INT) Get an edge point.
building_blocks.edge.start.face(BB_EDGE_PNT) Get the first face in a list.
building_blocks.edge.start.index(BB_EDGE_PNT) Get the index of the first face in a list.
building_blocks.edge.toglobal(BB_EDGE_PNT,FLT) Get the global coordinates of a point from local coordinates.
building_blocks.edge.tolocal(BB_EDGE_PNT,VEC) Get the local coordinate of a point from global coordinates.
building_blocks.edge.type(BB_EDGE_PNT) Get edge type.

Building Blocks Point Functions

building_blocks.point.pos(BB_POINT_PNT) Get point position.
building_blocks.point.start.edge(BB_POINT_PNT) Get the first edge in a list.
building_blocks.point.start.index(BB_POINT_PNT) Get the index of this point on the first edge...

Building Blocks Set Functions

building_blocks.set.block.create(BB_SET_PNT,STR,VEC,VEC,VEC,VEC<,VEC><,VEC><,VEC><,VEC>) Create a block.
building_blocks.set.block.find(BB_SET_PNT,INT) Get a block by ID.
building_blocks.set.block.list(BB_SET_PNT) Get a block container from a set.
building_blocks.set.block.remove(BB_SET_PNT,BB_BLOCK_PNT) Remove a block from a set.
building_blocks.set.block.size(BB_SET_PNT) Get the number of blocks in a set.
building_blocks.set.create(STR<,INT>) Create a building blocks set.
building_blocks.set.delete(BB_SET_PNT) Delete a building blocks set.
building_blocks.set.edge.find(BB_SET_PNT,INT) Get an edge by ID.
building_blocks.set.edge.list(BB_SET_PNT) Get an edge container from a set.
building_blocks.set.edge.near(BB_SET_PNT,VEC<,FLT>) Get the nearest edge from coordinates.
building_blocks.set.edge.size(BB_SET_PNT) Get the number of edges.
building_blocks.set.face.find(BB_SET_PNT,INT) Get face by ID.
building_blocks.set.face.list(BB_SET_PNT) Get a face container from a set.
building_blocks.set.face.near(BB_SET_PNT,VEC<,FLT>) Get the nearest face from coordinates.
building_blocks.set.face.size(BB_SET_PNT) Get the number of faces in a set.
building_blocks.set.find(INT/STR) Get a set by the name or by ID.
building_blocks.set.id(BB_SET_PNT) Get the building blocks set ID.
building_blocks.set.list Get a container of building blocks sets.
building_blocks.set.name(BB_SET_PNT) Get the name of the building blocks set.
building_blocks.set.point.find(BB_SET_PNT,INT) Get a point by ID.
building_blocks.set.point.list(BB_SET_PNT) Get a point container from a set.
building_blocks.set.point.near(BB_SET_PNT,VEC<,FLT>) Get the nearest point from coordinates.
building_blocks.set.point.size(BB_SET_PNT) Get the number of points in a set.