api_get_entity_refinement
List of: Functions
Subjects: Faceting, Viewing
Contents: Faceter

Action: Gets the refinement attached to the entity.

Prototype: outcome api_get_entity_refinement (


ENTITY* entity, // entity to examine


REFINEMENT*& ref, // refinement attached


AF_SURF_MODE surftype // type of surface



= AF_SURF_ALL, // returned (optional)


AcisOptions* ao = NULL // acis options


);

Includes: #include "kernel/acis.hxx"

#include "faceter/api/af_api.hxx"

#include "faceter/attribs/af_enum.hxx"

#include "faceter/attribs/refine.hxx"

#include "kernel/kernapi/api/api.hxx"

#include "kernel/kerndata/data/entity.hxx"

#include "kernel/kernapi/api/acis_options.hxx"

Description: If none with the given type is found, a NULL value is returned. The surface type may be one of:


AF_SURF_ALL = all surfaces

AF_SURF_REGULAR = plane, cone, sphere, torus

AF_SURF_IRREGULAR = spline

AF_SURF_PLANE = plane

AF_SURF_CONE = cone

AF_SURF_SPHERE = sphere

AF_SURF_TORUS = torus

AF_SURF_SPLINE = spline


If surface type is not passed, it is set to AF_SURF_ALL.

Errors: Pointer to entity is NULL or not to an BODY, LUMP, SHELL, or FACE.

Library: faceter

Filename: fct/faceter/api/af_api.hxx

Effect: Read-only
PDF/FCT/03FN.PDF
HTM/DATA/FCT/FCT/03FN/0026.HTM