Home

Rendering Base
[Model Visualization and Display]

Collaboration diagram for Rendering Base:
and is required if either interactive or batch rendering is to be performed on an ACIS model. More...

Classes

class  ATTRIB_COL
 Stores color information for an ENTITY. More...
class  NORENDER_ATTRIB
 Defines a generic attribute type that can mark a face or entity to not be rendered. More...
class  rbase_app_callback
 Implements routines to handle various rendering application callbacks for image output and interrupts. More...
class  Render_Arg
 Provides the mechanism for getting and setting shader parameters. More...
class  Render_Color
 Represents an RGB color. More...
class  RH_BACKGROUND
 Defines a background. More...
class  RH_ENTITY
 Provides common methods and data for other rendering classes. More...
class  RH_ENVIRONMENT_MAP
 Defines an environment map. More...
class  RH_FOREGROUND
 Defines a foreground. More...
class  RH_LIGHT
 Defines a light source. More...
class  RH_MATERIAL
 Defines a material consisting of color, displacement, reflectance, and transparency. More...
class  RH_TEXTURE_SPACE
 Defines a texture space. More...

Defines

#define BIT_IN   0x2
 
#define BIT_LEFT   0x4
 
#define BIT_RIGHT   0x1
 
#define DATA_ID   RH_ADVANCED_DATA
 
#define DEFAULT_FAR_CLIP   1000.0
 
#define DEFAULT_FIELD_OF_VIEW   90.0
 
#define DEFAULT_HORIZONTAL_RESOLUTION   768
 
#define DEFAULT_NEAR_CLIP   1.0
 
#define DEFAULT_VERTICAL_RESOLUTION   512
 
#define LW_CONVERSION_DITHER_RGB   (LwConversionMethod)0
 
#define LW_CONVERSION_FS_DITHER_RGB   (LwConversionMethod)2
 
#define LW_CONVERSION_FS_MONOCHROME   (LwConversionMethod)3
 
#define LW_CONVERSION_FS_RGB   (LwConversionMethod)1
 
#define LW_CONVERSION_GREYSCALE   (LwConversionMethod)4
 
#define LW_CONVERSION_NEAREST_RGB   (LwConversionMethod)5
 
#define LW_CONVERSION_O_DITHER_RGB   (LwConversionMethod)6
 
#define LW_CONVERSION_TC_DITHER   (LwConversionMethod)7
 
#define LwVoid   void
 
#define RC_BLUE   2
 Indices for accessing members of RGB color triples.
#define RC_GREEN   1
 Indices for accessing members of RGB color triples.
#define RC_RED   0
 Indices for accessing members of RGB color triples.
#define RH_ADVANCED_DATA   4
 
#define RH_EXTERNAL_DATA   1
 
#define RH_NO_DATA   0
 
#define RH_STANDARD_DATA   2
 
#define SMALL_DISPLACEMENT   0.0001
 
#define SMALL_VECTOR   0.0001
 

Typedefs

typedef void(* Image_Access_Function )(unsigned char *result, void *data, int x, int y)
 Image Access Function.
typedef LwInt32 LwConversionMethod
 Image conversion method type.
typedef LwInt32 LwDisplayMethod
 Image display method.
typedef float LwFloat
 Floating point value.
typedef int LwInt32
 32-bit signed integer.
typedef unsigned char LwNat8
 8-bit unsigned integer.

Enumerations

enum  Arg_Type
 Defines the type of data held by a Render_Arg. More...
enum  Environment_Field
 Values used for accessing the fields of a cubic environment map. More...
enum  On_Off_Type
 Used primarily to set and get ON_OFF arguments. More...
enum  Output_Mode
 Specifies the format of scanlines output by subsequent rendering calls to application graphics drivers. More...
enum  Projection_Type
 Specifies the type of projection Required for refinement criterion that use image space. More...
enum  Render_Control_Var
 Rendering control variables for ray-tracing. More...
enum  Render_Mode
 Specifies the mode of rendering. More...
enum  RNDR_PROJECTION_TYPE
 Specifies the type of projection to use when rendering. More...
enum  Shader_Type
 Specifies the type of a shader. More...

Functions

void add_rbase_app_cb (rbase_app_callback *cb)
 Creates a register of the callback.
outcome api_initialize_rendering ()
 Initializes the rendering library.
outcome api_rh_convert_image_end ()
 Terminates conversion of an image.
outcome api_rh_convert_image_start (LwInt32 width, LwInt32 height)
 Starts conversion of an image.
outcome api_rh_convert_rgb_float_scanline (LwFloat *input, LwInt32 *output)
 Converts a scanline of LwFloat values.
outcome api_rh_convert_rgb_scanline (LwNat8 *input, LwInt32 *output)
 Converts a scanline of LwNat8 values.
outcome api_rh_copy_background (RH_BACKGROUND *background, RH_BACKGROUND *&new_background)
 Creates a copy of a background.
outcome api_rh_copy_foreground (RH_FOREGROUND *foreground, RH_FOREGROUND *&new_foreground)
 Creates a copy of a foreground.
outcome api_rh_copy_light (RH_LIGHT *light, RH_LIGHT *&new_light)
 Creates a copy of a light.
outcome api_rh_copy_material (RH_MATERIAL *material, RH_MATERIAL *&new_material)
 Creates a copy of a material.
outcome api_rh_copy_texture_space (RH_TEXTURE_SPACE *texture_space, RH_TEXTURE_SPACE *&new_texture_space)
 Copies a texture space.
outcome api_rh_create_background (const char *name, RH_BACKGROUND *&background)
 Creates a background.
outcome api_rh_create_cube_environment (unsigned char *data[6], int channels, int width[6], int height[6], Image_Access_Function afunc, RH_ENVIRONMENT_MAP *&env_map)
 Creates an environment map from six raster images.
outcome api_rh_create_foreground (const char *name, RH_FOREGROUND *&foreground)
 Creates a foreground.
outcome api_rh_create_light (const char *type, RH_LIGHT *&light)
 Creates a light.
outcome api_rh_create_light_shadow (RH_LIGHT *light, ENTITY_LIST const &entities)
 Creates a shadow mask for a light from a list of entities.
outcome api_rh_create_material (RH_MATERIAL *&material)
 Creates a material.
outcome api_rh_create_texture_space (const char *name, RH_TEXTURE_SPACE *&texture_space)
 Creates a texture space.
outcome api_rh_def_color_comp (const char *name)
 Sets a material's default color component.
outcome api_rh_def_displace_comp (const char *name)
 Sets a material's default displacement component.
outcome api_rh_def_reflect_comp (const char *name)
 Sets a material's default displacement component.
outcome api_rh_def_transp_comp (const char *name)
 Sets a material's default transparency component.
outcome api_rh_delete_background (RH_BACKGROUND *background)
 Deletes a background.
outcome api_rh_delete_environment_map (RH_ENVIRONMENT_MAP *map)
 Deletes an environment map.
outcome api_rh_delete_foreground (RH_FOREGROUND *foreground)
 Deletes a foreground.
outcome api_rh_delete_light (RH_LIGHT *light)
 Deletes a light.
outcome api_rh_delete_light_shadow (RH_LIGHT *light)
 Deletes a light's shadow.
outcome api_rh_delete_material (RH_MATERIAL *material)
 Deletes a material.
outcome api_rh_delete_texture_space (RH_TEXTURE_SPACE *texture_space)
 Deletes a texture space.
outcome api_rh_display_image (LwInt32 width, LwInt32 height, LwDisplayMethod method, LwInt32 n_colours, void(*input_scanline)(LwInt32 y, LwNat8 **scan), void(*output_scanline)(LwInt32 y, LwInt32 *scan), void(*set_colour_map)(LwNat8 *colours))
 Sets the display image parameters.
outcome api_rh_get_background (RH_BACKGROUND *&background)
 Gets the current background.
outcome api_rh_get_background_args (RH_BACKGROUND *background, const char *&name, int &no_of_args, const char **&arg_names, Render_Arg *&arg_values)
 Gets the arguments of a background.
outcome api_rh_get_background_types (int &n_backgrounds, const char **&names)
 Gets a list of valid background type names.
outcome api_rh_get_clipping (double &near_clipping_plane, double &far_clipping_plane)
 Gets the depth clipping parameters that affect view-dependent faceting.
outcome api_rh_get_color_comp (RH_MATERIAL *material, const char *&name, int &no_of_args, const char **&arg_names, Render_Arg *&arg_values)
 Gets the arguments of a material's color component.
outcome api_rh_get_color_comp_list (int &n_colors, const char **&names)
 Gets a list of valid color component names.
outcome api_rh_get_control_variable (Render_Control_Var var, Render_Arg &value)
 Gets a render control variable.
outcome api_rh_get_default_background_rgb (rgb_color &color)
 Gets the background default RGB color for new toolkit graphics windows.
outcome api_rh_get_default_edge_rgb (rgb_color &color)
 Gets the default RGB color for new edge entities.
outcome api_rh_get_default_face_rgb (rgb_color &color)
 Gets the default RGB color for new face entities.
outcome api_rh_get_default_rgb (rgb_color &color)
 Gets the default RGB color for newly-created entities.
outcome api_rh_get_default_vertex_rgb (rgb_color &color)
 Gets the default RGB color for new vertex entities.
outcome api_rh_get_displace_comp (RH_MATERIAL *material, const char *&name, int &no_of_args, const char **&arg_names, Render_Arg *&arg_values)
 Gets the arguments of a material's displacement component.
outcome api_rh_get_displace_comp_list (int &n_displaces, const char **&names)
 Gets a list of valid displacement component names.
outcome api_rh_get_displace_status (RH_MATERIAL *material, logical &status)
 Gets the status of a material's displacement component.
outcome api_rh_get_entity_rgb (ENTITY *ent, rgb_color &color, logical inherit, logical &found)
 Gets the RGB color of an entity.
outcome api_rh_get_environment_map (RH_ENVIRONMENT_MAP *&map)
 Gets the current environment map.
outcome api_rh_get_foreground (RH_FOREGROUND *&foreground)
 Gets the current foreground.
outcome api_rh_get_foreground_args (RH_FOREGROUND *foreground, const char *&name, int &no_of_args, const char **&arg_names, Render_Arg *&arg_values)
 Gets the arguments of a foreground.
outcome api_rh_get_foreground_types (int &n_foregrounds, const char **&names)
 Gets a list of valid foreground type names.
outcome api_rh_get_highlight_rgb (rgb_color &color)
 Gets the RGB color used to highlight entities.
outcome api_rh_get_light_args (RH_LIGHT *light, const char *&name, int &no_of_args, const char **&arg_names, Render_Arg *&arg_values)
 Gets the arguments of a light.
outcome api_rh_get_light_list (ENTITY_LIST &lights)
 Gets the contents of the active light list.
outcome api_rh_get_light_state (RH_LIGHT *light, logical *on_off)
 Gets the on/off state of light.
outcome api_rh_get_light_types (int &n_types, const char **&names)
 Gets a list of valid light type names.
outcome api_rh_get_material (ENTITY *entity, RH_MATERIAL *&material)
 Gets the material attached to an entity.
outcome api_rh_get_material_color (ENTITY *entity, double &red, double &green, double &blue, logical &found)
 Gets the material color associated with a geometric entity.
outcome api_rh_get_material_reflection (ENTITY *entity, double &ambient, double &diffuse, double &specular, double &exponent)
 Gets the material reflection properties associated with a geometric entity.
outcome api_rh_get_material_texture (ENTITY *entity, const char *&tex_name)
 Gets the material texture associated with a geometric entity.
outcome api_rh_get_material_transp (ENTITY *entity_list, double &transp)
 Gets the material transparency associated with a geometric entity.
outcome api_rh_get_output_mode (Output_Mode &output_mode)
 Gets the current output mode.
outcome api_rh_get_reflect_comp (RH_MATERIAL *material, const char *&name, int &no_of_args, const char **&arg_names, Render_Arg *&arg_values)
 Gets the arguments of a material's reflectance component.
outcome api_rh_get_reflect_comp_list (int &n_reflects, const char **&names)
 Gets a list of valid reflectance component names.
outcome api_rh_get_reflect_status (RH_MATERIAL *material, logical &status)
 Gets the status of a material's reflection component.
outcome api_rh_get_render_mode (Render_Mode &render_mode)
 Gets the current render mode.
outcome api_rh_get_resolution (int &width, int &height, double &pixel_aspect_ratio, double &image_scale)
 Gets the default screen faceting resolution controls.
outcome api_rh_get_sidedness (ENTITY *entity, int &sides)
 Gets the sidedness of an entity.
outcome api_rh_get_sub_image (int &left, int &right, int &top, int &bottom)
 Gets the pixel coordinates of the region of interest on a screen.
outcome api_rh_get_texture_space (ENTITY *entity, RH_TEXTURE_SPACE *&texture_space)
 Gets the texture space attached to an entity.
outcome api_rh_get_texture_space_args (RH_TEXTURE_SPACE *texture_space, const char *&name, int &no_of_args, const char **&arg_names, Render_Arg *&arg_values)
 Gets the arguments of a texture space.
outcome api_rh_get_texture_space_types (int &n_types, const char **&names)
 Gets a list of valid texture space type names.
outcome api_rh_get_transp_comp (RH_MATERIAL *material, const char *&name, int &no_of_args, const char **&arg_names, Render_Arg *&arg_values)
 Gets the arguments of a material's transparency component.
outcome api_rh_get_transp_comp_list (int &n_transparencies, const char **&names)
 Gets a list of valid transparency component names.
outcome api_rh_get_transp_status (RH_MATERIAL *material, logical &status)
 Gets the status of a material's transparency component.
outcome api_rh_get_view (SPAposition &from_point, SPAposition &to_point, SPAvector &view_up_vector, Projection_Type &projection, double &field_of_view)
 Gets the view parameters that affect view-dependent faceting.
outcome api_rh_initialise ()
 Initializes the renderer.
outcome api_rh_initialise_image_utilities ()
 Initializes the Image Utilities Library.
outcome api_rh_initialise_supl_shaders ()
 Initializes the supplemental shaders.
outcome api_rh_read_lightworks_image (FILE *fp, LwInt32 channels, LwInt32 width, LwInt32 height, LwNat8 *data)
 Gets the LightWorks image for display.
outcome api_rh_read_lightworks_image_size (FILE *fp, LwInt32 *width, LwInt32 *height)
 Gets the LightWorks image size.
outcome api_rh_render_cube_environment (ENTITY_LIST const &entities, int resolution, SPAposition const &view_point, RH_ENVIRONMENT_MAP *&map)
 Creates an environment map from a list of entities.
outcome api_rh_render_entities (ENTITY_LIST const &entities, logical clear_screen=TRUE)
 Renders a list of entities.
outcome api_rh_set_background (RH_BACKGROUND *background)
 Sets the current background.
outcome api_rh_set_background_arg (RH_BACKGROUND *background, const char *arg_name, const Render_Arg &value)
 Sets an argument for a background.
outcome api_rh_set_clipping (double near_clipping_plane, double far_clipping_plane)
 Sets the near and far clipping planes for faceting.
outcome api_rh_set_color_arg (RH_MATERIAL *material, const char *arg_name, const Render_Arg &value)
 Sets an argument of a material's color component.
outcome api_rh_set_color_comp (RH_MATERIAL *material, const char *color_shader_name)
 Sets the color component of a material.
outcome api_rh_set_control_variable (Render_Control_Var var, const Render_Arg &value)
 Sets a render control variable.
outcome api_rh_set_conversion_colour_map (LwInt32 r_max, LwInt32 g_max, LwInt32 b_max, LwInt32 r_mult, LwInt32 g_mult, LwInt32 b_mult, LwInt32 base_index)
 Sets the color map for conversion.
outcome api_rh_set_conversion_method (LwConversionMethod method)
 Sets the method for conversion.
outcome api_rh_set_default_background_rgb (rgb_color color)
 Gets the default background RGB color for new toolkit graphics windows.
outcome api_rh_set_default_edge_rgb (rgb_color color)
 Gets the default RGB color for edge entities.
outcome api_rh_set_default_face_rgb (rgb_color color)
 Gets the default RGB color for new face entities.
outcome api_rh_set_default_rgb (rgb_color color)
 Modifies the default RGB color for newly-created entities.
outcome api_rh_set_default_vertex_rgb (rgb_color color)
 Gets the default RGB color for new vertex entities.
outcome api_rh_set_displace_arg (RH_MATERIAL *material, const char *arg_name, const Render_Arg &value)
 Sets an argument of a material's displacement component.
outcome api_rh_set_displace_comp (RH_MATERIAL *material, const char *name)
 Sets a material's displacement component.
outcome api_rh_set_displace_status (RH_MATERIAL *material, logical status)
 Sets the status of a material's displacement component.
outcome api_rh_set_entity_rgb (ENTITY *ent, rgb_color color)
 Modifies the RGB color index of an ENTITY.
outcome api_rh_set_environment_map (RH_ENVIRONMENT_MAP *map)
 Sets the current environment map.
outcome api_rh_set_foreground (RH_FOREGROUND *foreground)
 Sets the current foreground.
outcome api_rh_set_foreground_arg (RH_FOREGROUND *foreground, const char *arg_name, const Render_Arg &value)
 Sets an argument of a foreground.
outcome api_rh_set_highlight_rgb (rgb_color color)
 Modifies the RGB color used to highlight entities.
outcome api_rh_set_light_arg (RH_LIGHT *light, const char *arg_name, const Render_Arg &value)
 Sets an argument for a light.
outcome api_rh_set_light_list (ENTITY_LIST const &lights)
 Sets the active light list.
outcome api_rh_set_light_state (RH_LIGHT *light, logical on_off)
 Sets the on/off state for a light.
outcome api_rh_set_material (ENTITY_LIST const &entities, RH_MATERIAL *material=(RH_MATERIAL *) NULL)
 Attaches a material to a list of entities.
outcome api_rh_set_material_color (ENTITY_LIST const &entities, double red, double green, double blue)
 Sets the color of a material associated with a geometric entity.
outcome api_rh_set_material_reflection (ENTITY_LIST const &entity_list, double ambient, double diffuse, double specular, double exponent)
 Sets the reflection properties in the material associated with a geometric entity.
outcome api_rh_set_material_texture (ENTITY_LIST const &entity_list, const char *tex_name)
 Sets the texture file name in the material associated with a geometric entity.
outcome api_rh_set_material_transp (ENTITY_LIST const &entity_list, double transp)
 Sets the transparency properties in the material associated with a geometric entity.
outcome api_rh_set_output_mode (Output_Mode output_mode)
 Sets the current rendering output mode.
outcome api_rh_set_reflect_arg (RH_MATERIAL *material, const char *arg_name, const Render_Arg &value)
 Sets an argument of a material's reflectance component.
outcome api_rh_set_reflect_comp (RH_MATERIAL *material, const char *reflectance_shader_name)
 Sets a material's reflectance component.
outcome api_rh_set_reflect_status (RH_MATERIAL *material, logical status)
 Sets a material's reflection status.
outcome api_rh_set_render_mode (Render_Mode render_mode)
 Sets the current render mode.
outcome api_rh_set_resolution (int width, int height, double pixel_aspect_ratio, double image_scale)
 Sets the default screen faceting resolution controls.
outcome api_rh_set_sidedness (ENTITY_LIST const &entities, int sides)
 Sets the sidedness of faces of entities.
outcome api_rh_set_sub_image (int left, int right, int top, int bottom)
 Sets the region of image importance within a screen image.
outcome api_rh_set_texture_space (ENTITY_LIST const &entities, RH_TEXTURE_SPACE *texture_space=(RH_TEXTURE_SPACE *) NULL)
 Attaches a texture space to a list of entities.
outcome api_rh_set_texture_space_arg (RH_TEXTURE_SPACE *texture_space, const char *arg_name, const Render_Arg &value)
 Sets an argument for a texture space.
outcome api_rh_set_transp_arg (RH_MATERIAL *material, const char *arg_name, const Render_Arg &value)
 Sets an argument of a material's transparency component.
outcome api_rh_set_transp_comp (RH_MATERIAL *material, const char *transparency_shader_name)
 Sets a material's transparency component.
outcome api_rh_set_transp_status (RH_MATERIAL *material, logical status)
 Sets a material's transparency status.
outcome api_rh_set_view (SPAposition from_point, SPAposition to_point, SPAvector view_up_vector, Projection_Type projection, double field_of_view)
 Sets the view parameters that affect view-dependent faceting.
outcome api_rh_terminate ()
 Terminates the renderer.
outcome api_rh_terminate_image_utilities ()
 Terminates the use of the Image Format Utility Library.
outcome api_terminate_rendering ()
 Terminates the rendering library.
NORENDER_ATTRIB * find_NORENDER_ATTRIB (const ENTITY *ent)
 Finds and returns a NORENDER_ATTRIB attached to an ENTITY.
logical is_Background_Type (const char *type)
 Determines if a character string represents a legal background type.
logical is_Color_Type (const char *type)
 Determines if a character string represents a legal color type.
logical is_Displace_Type (const char *type)
 Determines if a character string represents a legal displacement type.
logical is_Foreground_Type (const char *type)
 Determines if a character string represents a legal foreground type.
logical is_Light_Type (const char *type)
 Determines if a character string represents a legal light type.
logical is_Reflect_Type (const char *type)
 Determines if a character string represents a legal reflection type.
logical is_Texture_Space_Type (const char *type)
 Determines if a character string represents a legal texture space type.
logical is_Transp_Type (const char *type)
 Determines if a character string represents a legal transparency type.
void remove_rbase_app_cb (rbase_app_callback *cb)
 Removes the callback.

Detailed Description

and is required if either interactive or batch rendering is to be performed on an ACIS model.

Declared at <rh_types.h>.

It facilitates swapping out renderers for the requirements of different platforms. Because RBASE must support all renderers, its set of API functions may contain functionality not supported in some renderers

Define Documentation

#define BIT_IN   0x2

#define BIT_LEFT   0x4

#define BIT_RIGHT   0x1

#define DATA_ID   RH_ADVANCED_DATA

#define DEFAULT_FAR_CLIP   1000.0

#define DEFAULT_FIELD_OF_VIEW   90.0

#define DEFAULT_HORIZONTAL_RESOLUTION   768

#define DEFAULT_NEAR_CLIP   1.0

#define DEFAULT_VERTICAL_RESOLUTION   512

#define LW_CONVERSION_DITHER_RGB   (LwConversionMethod)0

#define LW_CONVERSION_FS_DITHER_RGB   (LwConversionMethod)2

#define LW_CONVERSION_FS_MONOCHROME   (LwConversionMethod)3

#define LW_CONVERSION_FS_RGB   (LwConversionMethod)1

#define LW_CONVERSION_GREYSCALE   (LwConversionMethod)4

#define LW_CONVERSION_NEAREST_RGB   (LwConversionMethod)5

#define LW_CONVERSION_O_DITHER_RGB   (LwConversionMethod)6

#define LW_CONVERSION_TC_DITHER   (LwConversionMethod)7

#define LwVoid   void

#define RC_BLUE   2

Indices for accessing members of RGB color triples.

#define RC_GREEN   1

Indices for accessing members of RGB color triples.

#define RC_RED   0

Indices for accessing members of RGB color triples.

#define RH_ADVANCED_DATA   4

#define RH_EXTERNAL_DATA   1

#define RH_NO_DATA   0

#define RH_STANDARD_DATA   2

#define SMALL_DISPLACEMENT   0.0001

#define SMALL_VECTOR   0.0001

Typedef Documentation

typedef void(* Image_Access_Function)(unsigned char *result, void *data, int x, int y)

Image Access Function.


Role: An image access function, is an application supplied function which given an x-y position and pointer to some application data, returns a color value for that position. The result is a pointer to an array of char's whose length depends upon the the no. of color channels in use. So that for 3 channels the result would be hold 3 RGB values. Image access functions are used for creating cube environment maps.

include <rh_args.hxx>

typedef LwInt32 LwConversionMethod

Image conversion method type.


Role:A 32-bit, signed integer which represents an image conversion method type.

include <rh_types.h>

typedef LwInt32 LwDisplayMethod

Image display method.


Role:A 32-bit, signed integer which represents an image display method.

include <rh_types.h>

typedef float LwFloat

Floating point value.


Role:A data type which represents a single precision floating point value.

include <rh_types.h>

typedef int LwInt32

32-bit signed integer.


Role:A 32-bit, signed integer which represents values in the range -2^31 to (2^31) - 1.

include <rh_types.h>

typedef unsigned char LwNat8

8-bit unsigned integer.


Role:An 8-bit, unsigned integer which represents values in the range 0 to 255.

include <rh_types.h>

Enumeration Type Documentation

enum Arg_Type

Defines the type of data held by a Render_Arg.

Parameters:
ARG_UNDEF Undefined argument.
ARG_INT Integer argument.
ARG_REAL Real argument.
ARG_STRING String argument.
ARG_COLOR Color argument.
ARG_VECTOR Vector argument.
ARG_ON_OFF On/off argument.
ARG_FALL_OFF Light fall off type argument.

include <rh_args.hxx>

enum Environment_Field

Values used for accessing the fields of a cubic environment map.

Parameters:
ENVIRONMENT_POS_X the positive X field.
ENVIRONMENT_NEG_X the negative X field.
ENVIRONMENT_POS_Y the positive Y field.
ENVIRONMENT_NEG_Y the negative Y field.
ENVIRONMENT_POS_Z the positive Z field.
ENVIRONMENT_NEG_Z the negative Z field.

include <rh_args.hxx>

enum On_Off_Type

Used primarily to set and get ON_OFF arguments.

Parameters:
OFF Integer argument.
ON Integer argument.

include <rh_args.hxx>

enum Output_Mode

Specifies the format of scanlines output by subsequent rendering calls to application graphics drivers.

Parameters:
OUTPUT_MODE_RGB RGB triples in range (unsigned char ) 0-255.
OUTPUT_MODE_Z World space values (real) specifying distance from visible surface to eye-point.
OUTPUT_MODE_RGB_FLOAT RGB triples (real).
OUTPUT_MODE_RGB_FLOAT_CLAMP RGB triples in range (real) 0 - 1.0.

include <rh_args.hxx>

enum Projection_Type

Specifies the type of projection Required for refinement criterion that use image space.


Parameters:
PROJ_ORTHOGRAPHIC Orthographic projection.
PROJ_PERSPECTIVE Perspective projection.

include <rnd_api.hxx>

enum Render_Control_Var

Rendering control variables for ray-tracing.

Parameters:
CVAR_OCTTREE_DEPTH octtree depth is the maximum depth of the octtree data structure constructed during ray tracing. An octtree is constructed when rendering using ray tracing, either in a ray tracing mode, or when ray tracing is required by a shader in preview or full rendering modes. The default is 8.
CVAR_OCTTREE_OCCUPANCY octtree occupancy is the maximum occupancy of a leaf cell of the octtree data structure constructed for ray tracing. The occupancy corresponds to the number of facets contained in an octtree leaf cell. An octtree is constructed when rendering using ray tracing, either in a ray tracing mode, or when ray tracing is required by a shader in the preview or full rendering modes. The default is 8.
CVAR_RAYTRACE_LEVEL raytrace level is the maximum level of recursion that is enforced when tracing secondary rays. The default is 16.
CVAR_MIN_PIXEL_CONTRIB min pixel contrib is used for determining whether the contribution made by a secondary ray can be ignored. A combination of this control variable and the level variable define the recursive ray tracing termination criteria. The range is 0.0 to 1.0. The default is 0.05.
CVAR_PIXEL_THRESHOLD pixel threshold controls anti-aliasing. It determines when to adaptively super-sample the image. The image is sampled until adjacentcolor samples differ in the largest of their red, green and blue components by an amount not exceeding the pixel threshold. Range is 0.0 to 1.0. The default is 0.1.

include <rh_args.hxx>

enum Render_Mode

Specifies the mode of rendering.

Parameters:
RENDER_MODE_FLAT Constant Color across facet.
RENDER_MODE_LAMBERT Illumination model based on the diffuse reflection of asurface.
RENDER_MODE_GOURAUD Interpolated intensities across facet.
RENDER_MODE_PHONG Interpolated normals across facet.
RENDER_MODE_PREVIEW Anti-aliasing and transparency.
RENDER_MODE_FULL All Visual attributes.
RENDER_MODE_RAYTRACE_PREVIEW Same as raytrace full but without anti-aliasing.
RENDER_MODE_RAYTRACE_FULL Same as full but with improved anti-aliasing on secondary effects.

include <rh_args.hxx>

enum RNDR_PROJECTION_TYPE

Specifies the type of projection to use when rendering.


Parameters:
RNDR_FLAT_PROJECTION Flat projection.
RNDR_PERSPECTIVE_PROJECTION Perspective projection.

include <rndr_env.hxx>

enum Shader_Type

Specifies the type of a shader.


Parameters:
RH_BACKGROUND_SHADER background.
RH_FOREGROUND_SHADER foreground.
RH_TEXTURE_SPACE_SHADER texture space.
RH_LIGHT_SHADER light.
RH_ENVIRONMENT_SHADER environment map.
REFLECTANCE_COMP_SHADER reflectance.
DISPLACEMENT_COMP_SHADER displacement (bump mapping).
COLOR_COMP_SHADER color.
TRANSPARENCY_COMP_SHADER transparency.

include <rh_func.hxx>

Function Documentation

void add_rbase_app_cb ( rbase_app_callback *  cb  ) 

Creates a register of the callback.



Effect: System routine

Parameters:
cb callback to register.

include <rbapp_cb.hxx>

outcome api_initialize_rendering (  ) 

Initializes the rendering library.



Effect: System routine

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

include <rnd_api.hxx>

outcome api_rh_convert_image_end (  ) 

Terminates conversion of an image.



Role: Call this function to end the conversion of an image. It must match a corresponding call to LwConvertImageStart. Call this function after the last scanline of the image has been converted using LwConvertRGBFloatScanline or LwConvertRGBScanline.

Effect: System routine

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

include <rnd_api.hxx>

outcome api_rh_convert_image_start ( LwInt32  width,
LwInt32  height 
)

Starts conversion of an image.



Role: This function initializes the image format process for an image of the given size. The image to be converted has dimensions of width pixels horizontally and height pixels vertically.

Effect: System routine

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
width image width.
height image height.

include <rnd_api.hxx>

outcome api_rh_convert_rgb_float_scanline ( LwFloat *  input,
LwInt32 *  output 
)

Converts a scanline of LwFloat values.



Role: This function converts an input array of pixel colors into a corresponding array of color map indexes, using the image conversion method previously set by LwSetConversionMethod. Call this function from the application-supplied function, rh_image_scanline.

Effect: System routine

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
input array of pixel colors.
output returns array of color map indexes.

include <rnd_api.hxx>

outcome api_rh_convert_rgb_scanline ( LwNat8 *  input,
LwInt32 *  output 
)

Converts a scanline of LwNat8 values.



Role: This function converts an input array of pixel colors into a corresponding array of color map indexes, using the image conversion method previously set with LwSetConversionMethod. Call this function from the application-supplied function, rh_image_scanline.

Effect: System routine

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
input array of pixel colors.
output returns array of color map indexes.

include <rnd_api.hxx>

outcome api_rh_copy_background ( RH_BACKGROUND *  background,
RH_BACKGROUND *&  new_background 
)

Creates a copy of a background.



Role: This API creates a new RH_BACKGROUND with the same properties as the old background.

Effect: Changes model

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
background old background.
new_background returns new background.

include <rnd_api.hxx>

outcome api_rh_copy_foreground ( RH_FOREGROUND *  foreground,
RH_FOREGROUND *&  new_foreground 
)

Creates a copy of a foreground.



Role: This API creates a new RH_FOREGROUND with the same properties as the old foreground.

Effect: Changes model

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
foreground old foreground.
new_foreground returns new foreground.

include <rnd_api.hxx>

outcome api_rh_copy_light ( RH_LIGHT *  light,
RH_LIGHT *&  new_light 
)

Creates a copy of a light.



Role: This API creates a new RH_LIGHT with the same properties as the old light.

Effect: Changes model

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
light old light.
new_light new light returned.

include <rnd_api.hxx>

outcome api_rh_copy_material ( RH_MATERIAL *  material,
RH_MATERIAL *&  new_material 
)

Creates a copy of a material.



Role: This API creates a new RH_MATERIAL with the same properties as the old material.

Effect: Changes model

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
material old material.
new_material new material returned.

include <rnd_api.hxx>

outcome api_rh_copy_texture_space ( RH_TEXTURE_SPACE *  texture_space,
RH_TEXTURE_SPACE *&  new_texture_space 
)

Copies a texture space.



Role: This API creates a new RH_TEXTURE_SPACE with the same properties as the old texture_space.

Effect: Changes model

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
texture_space original texture space.
new_texture_space new texture space returned.

include <rnd_api.hxx>

outcome api_rh_create_background ( const char *  name,
RH_BACKGROUND *&  background 
)

Creates a background.



Role: This API creates a new RH_BACKGROUND. Once the background has been created, set the its properties using api_rh_set_background_arg. Set the current background using api_rh_set_background. Obtain a list of available background types by calling api_rh_get_background_types.

Errors: The name of the background is not one of the supported types.

Effect: Changes model

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
name name of background.
background new background returned.

include <rnd_api.hxx>

outcome api_rh_create_cube_environment ( unsigned char *  data[6],
int  channels,
int  width[6],
int  height[6],
Image_Access_Function  afunc,
RH_ENVIRONMENT_MAP *&  env_map 
)

Creates an environment map from six raster images.



Role: This API supports external reflections by creating a cubical environment map from six raster images supplied by the application.If the image access function is NULL, the default treats the image data as a raster image stored in row major order; otherwise, it is up to the application-supplied image access function to interpret the data.

Limitations: Replay is not supported.

Effect: System routine

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
data array of six raster image pointers.
channels number of channels in image data 1 or 3.
width width of images.
height height of images.
afunc image access function.
env_map new environment map returned.

include <rnd_api.hxx>

outcome api_rh_create_foreground ( const char *  name,
RH_FOREGROUND *&  foreground 
)

Creates a foreground.



Role: Once the RH_FOREGROUND is created, set the foreground properties using api_rh_set_foreground_arg.Set the current foreground using api_rh_set_foreground.Obtain a list of available foreground types by calling api_rh_get_foreground_types.

Errors: The name of the foreground is not one of the supported types.

Effect: Changes model

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
name name of foreground.
foreground new foreground returned.

include <rnd_api.hxx>

outcome api_rh_create_light ( const char *  type,
RH_LIGHT *&  light 
)

Creates a light.



Role: This API creates a new RH_LIGHT. Once it is created, set the light properties using api_rh_set_light_arg. Obtain a list of supported light types by calling api_rh_get_light_types.

Errors: The name of the light is not one of the supported types.

Effect: Changes model

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
type type of light.
light new light returned.

include <rnd_api.hxx>

outcome api_rh_create_light_shadow ( RH_LIGHT *  light,
ENTITY_LIST const &  entities 
)

Creates a shadow mask for a light from a list of entities.



Role: A shadow mask is a depth buffered image computed from the view point of a light source. Shadow masks help render shadows. The resolution of the shadow image depends upon the shadow resolution parameter associated with the light source shader.Set the resolution using api_rh_set_light_arg.

Limitations: Recompute a shadow map if certain parameters of the light, such as location, are changed or if the geometry of the objects in a scene has altered.

Effect: Changes model

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
light light.
entities light entity list.

include <rnd_api.hxx>

outcome api_rh_create_material ( RH_MATERIAL *&  material  ) 

Creates a material.



Role: Each material contains four shaders, color, displacement, reflectance, and transparency, and it is initialized to the default shaders specified using the api_rh_def_APIs. Once a material is created, attach the material to entities using api_rh_set_material. Set a material's properties by manipulating its four component shaders.

Effect: Changes model

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
material new material returned.

include <rnd_api.hxx>

outcome api_rh_create_texture_space ( const char *  name,
RH_TEXTURE_SPACE *&  texture_space 
)

Creates a texture space.



Role: This API creates an RH_TEXTURE_SPACE.The texture space name must correspond to that of an existing texture space shader prototype with that name.Set texture space properties using api_rh_set_texture_space_arg.Texture spaces modify the image based on the coordinates of each pixel. Texture spaces can make an object appear to be carved out of a solid material or wrapped in a sheet of material.

Errors: The name of the texture space is not one of the supported types.

Effect: Changes model

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
name name of texture space.
texture_space new textures space returned.

include <rnd_api.hxx>

outcome api_rh_def_color_comp ( const char *  name  ) 

Sets a material's default color component.



Role: This API sets the default color shader to one of the known color shaders, obtained using api_rh_get_color_comp_list.

An RH_MATERIAL is defined by four component shaders: a color shader, a displacement shader, a reflectance shader, and a transparency shader. When an instance of an RH_MATERIAL is created, the type of shader components that it is initially created with depends on the default values set using this and other default shader component functions.

Errors: The name of the color shader is not one of the supported types.

Effect: System routine

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
name name of color shader.

include <rnd_api.hxx>

outcome api_rh_def_displace_comp ( const char *  name  ) 

Sets a material's default displacement component.



Role: This API sets the default displacement shader to one of the known displacement shader names, obtained using api_rh_get_displace_comp_list.

An RH_MATERIAL is defined by four component shaders: a color shader, a displacement shader, a reflectance shader, and a transparency shader. When an instance of an RH_MATERIAL is created, the type of shader components that it is initially created with depends on the default values set using this and other default shader component functions.

Errors: The name of displacement shader is not one of the supported types.

Effect: System routine

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
name name of displacement shader.

include <rnd_api.hxx>

outcome api_rh_def_reflect_comp ( const char *  name  ) 

Sets a material's default displacement component.



Role: This API sets the default reflectance shader to one of the known reflectance shader names, obtained using api_rh_get_reflect_comp_list.

An RH_MATERIAL is defined by four component shaders: a color shader, a displacement shader, a reflectance shader, and a transparency shader. When an instance of an RH_MATERIAL is created, the type of shader components that it is initially created with depends on the default values set using this and other default shader component functions.

Errors: The name of reflectance shader is not one of the supported types.

Effect: System routine

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
name name of displacement shader.

include <rnd_api.hxx>

outcome api_rh_def_transp_comp ( const char *  name  ) 

Sets a material's default transparency component.



Role: This API sets the default transparency shader to one of the known transparency shaders, obtained using api_rh_get_transp_comp_list.

An RH_MATERIAL is defined by four component shaders: a color shader, a displacement shader, a reflectance shader, and a transparency shader. When an instance of an RH_MATERIAL is created, the type of shader components that it is initially created with depends on the default values set using this and other default shader component functions.

Errors: Name of transparency shader is not one of the supported types.

Effect: System routine

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
name name of transparency shader.

include <rnd_api.hxx>

outcome api_rh_delete_background ( RH_BACKGROUND *  background  ) 

Deletes a background.



Role: When a background is deleted, do not use its handle in subsequent calls of api_rh_set_background. If the background currently in use by the rendering library has been deleted, reset it by calling api_rh_set_background.

Effect: Changes model

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
background background.

include <rnd_api.hxx>

outcome api_rh_delete_environment_map ( RH_ENVIRONMENT_MAP *  map  ) 

Deletes an environment map.



Role: When an environment map is deleted, do not use its handle in subsequent calls of api_rh_set_environment_map. If the environment map currently in use by the rendering library is deleted, reset the current environment by calling api_rh_set_environment_map.

Effect: Changes model

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
map environment map to be deleted.

include <rnd_api.hxx>

outcome api_rh_delete_foreground ( RH_FOREGROUND *  foreground  ) 

Deletes a foreground.



Role: When a foreground is deleted, do not use its handle in subsequent calls of api_rh_set_foreground. If the foreground currently in use by the rendering library has been deleted, reset it by calling api_rh_set_foreground.

Effect: Changes model

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
foreground foreground.

include <rnd_api.hxx>

outcome api_rh_delete_light ( RH_LIGHT *  light  ) 

Deletes a light.



Role: When a light is deleted,do not use its pointer in subsequent calls of api_rh_set_light_list. If a light is deleted from the rendering library's current light list, reset the light list by calling api_rh_set_light_list.

Effect: Changes model

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
light light.

include <rnd_api.hxx>

outcome api_rh_delete_light_shadow ( RH_LIGHT *  light  ) 

Deletes a light's shadow.



Role: This API deletes the shadow map associated with the light. Obtain the light handle by previously calling api_rh_create_light or api_rh_copy_light. To create a shadow map for a light, call api_rh_create_light_shadow.

If this API is called with an invalid light or if the light is not currently maintaining a shadow map, the call is ignored.

Effect: Changes model

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
light light.

include <rnd_api.hxx>

outcome api_rh_delete_material ( RH_MATERIAL *  material  ) 

Deletes a material.



Role: Delete all materials that have been created before terminating the renderer.

Errors: Errors may occur if a material attached to one or more entities is deleted.

Effect: Changes model

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
material material.

include <rnd_api.hxx>

outcome api_rh_delete_texture_space ( RH_TEXTURE_SPACE *  texture_space  ) 

Deletes a texture space.



Role: Texture spaces can be attached to other entities as properties. Delete all texture spaces that have been created before terminating the renderer. Do not delete a texture space that may be referenced by some other entity.

Errors: Errors may occur if a texture space attached to one or more entities is deleted.

Effect: Changes model

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
texture_space texture space.

include <rnd_api.hxx>

outcome api_rh_display_image ( LwInt32  width,
LwInt32  height,
LwDisplayMethod  method,
LwInt32  n_colours,
void(*)(LwInt32 y, LwNat8 **scan)  input_scanline,
void(*)(LwInt32 y, LwInt32 *scan)  output_scanline,
void(*)(LwNat8 *colours)  set_colour_map 
)

Sets the display image parameters.



Effect: System routine

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
width image width.
height image height.
method render mode.
n_colours number of colors.
y number of scan lines.
scan input display.
y number of scan lines.
scan the output.
colours set the color map for the output.

include <rnd_api.hxx>

outcome api_rh_get_background ( RH_BACKGROUND *&  background  ) 

Gets the current background.



Role: This API gets the current background shader used by the Rendering Base Component to color pixels that are not covered by an object. If the current background is NULL, the background is black.

Effect: Read-only

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
background returns background to be queried.

include <rnd_api.hxx>

outcome api_rh_get_background_args ( RH_BACKGROUND *  background,
const char *&  name,
int &  no_of_args,
const char **&  arg_names,
Render_Arg *&  arg_values 
)

Gets the arguments of a background.



Role: Each background has a list of named arguments.The number and names of those arguments depend on the type of the background.Access the value of each argument via the Render_Arg class.

This API returns the name of the background type with two lists containing the names and values of those arguments. All returned pointer values point to internal data structures.

For efficiency, these values are not copied when the API is called.The application should not free the memory pointed to by those pointers.In the case of Render_Arg, the internal array is re-used by other inquiry functions.It is up to the application to copy those values, if required, before any subsequent inquiry functions.

Effect: Read-only

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
background background to be queried.
name returns name of background type.
no_of_args returns number of arguments.
arg_names returns array of argument names.
arg_values returns array of arguments.

include <rnd_api.hxx>

outcome api_rh_get_background_types ( int &  n_backgrounds,
const char **&  names 
)

Gets a list of valid background type names.



Role: This API points to a list of valid RH_BACKGROUND type names. The list should not be freed by the application.

Effect: Read-only

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
n_backgrounds length of list of names.
names list of names.

include <rnd_api.hxx>

outcome api_rh_get_clipping ( double &  near_clipping_plane,
double &  far_clipping_plane 
)

Gets the depth clipping parameters that affect view-dependent faceting.



Effect: Read-only

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
near_clipping_plane returns near clipping plane.
far_clipping_plane returns far clipping plane.

include <rnd_api.hxx>

outcome api_rh_get_color_comp ( RH_MATERIAL *  material,
const char *&  name,
int &  no_of_args,
const char **&  arg_names,
Render_Arg *&  arg_values 
)

Gets the arguments of a material's color component.



Role: Each material color component has a list of named arguments.The number and names of those arguments depend on the type of color component.Access the value of each argument via the Render_Arg class.

This API returns the name of the color component type with two lists containing the names and values of those arguments.All returned pointer values point to internal data structures.

For efficiency, these values are not copied when the API is called.The application should not free the memory pointed to by those pointers.In the case of Render_Arg, the internal array is re-used by other inquiry functions.It is up to the application to copy those values, if required, before any subsequent inquiry functions.

Effect: Read-only

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
material material to be queried.
name name of color component type.
no_of_args number of arguments.
arg_names array of argument names.
arg_values returns array of arguments.

include <rnd_api.hxx>

outcome api_rh_get_color_comp_list ( int &  n_colors,
const char **&  names 
)

Gets a list of valid color component names.



Role: The list should not be freed by the application.

Effect: Read-only

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
n_colors returns length of list of names.
names returns list of names.

include <rnd_api.hxx>

outcome api_rh_get_control_variable ( Render_Control_Var  var,
Render_Arg &  value 
)

Gets a render control variable.



Role: For a list of control variable names, refer to the chapter on Control Variables.

Effect: Read-only

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
var control variable.
value returns control variable's value.

include <rnd_api.hxx>

outcome api_rh_get_default_background_rgb ( rgb_color &  color  ) 

Gets the background default RGB color for new toolkit graphics windows.



Effect: Read-only

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
color returned color.

include <rnd_api.hxx>

outcome api_rh_get_default_edge_rgb ( rgb_color &  color  ) 

Gets the default RGB color for new edge entities.



Effect: Read-only

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
color returned color.

include <rnd_api.hxx>

outcome api_rh_get_default_face_rgb ( rgb_color &  color  ) 

Gets the default RGB color for new face entities.



Effect: Read-only

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
color returned color.

include <rnd_api.hxx>

outcome api_rh_get_default_rgb ( rgb_color &  color  ) 

Gets the default RGB color for newly-created entities.



Effect: Read-only

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
color returned color.

include <rnd_api.hxx>

outcome api_rh_get_default_vertex_rgb ( rgb_color &  color  ) 

Gets the default RGB color for new vertex entities.



Effect: Read-only

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
color returned color.

include <rnd_api.hxx>

outcome api_rh_get_displace_comp ( RH_MATERIAL *  material,
const char *&  name,
int &  no_of_args,
const char **&  arg_names,
Render_Arg *&  arg_values 
)

Gets the arguments of a material's displacement component.



Role: Each material displacement component has a list of named arguments. The number and names of those arguments depend on the type of displacement component. Access the value of each argument via the Render_Arg class.

This API returns the name of the displacement component type with two lists containing the names and values of those arguments. All returned pointer values point to internal data structures.

For efficiency, these values are not copied when the API is called. The application should not free the memory pointed to by those pointers.In the case of Render_Arg, the internal array is re-used by other inquiry functions.It is up to the application to copy those values, if required, before any subsequent inquiry functions.

Effect: Read-only

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
material material to be queried.
name returns name of displacement component type.
no_of_args returns number of arguments.
arg_names returns array of argument names.
arg_values returns array of arguments.

include <rnd_api.hxx>

outcome api_rh_get_displace_comp_list ( int &  n_displaces,
const char **&  names 
)

Gets a list of valid displacement component names.



Role: The list should not be freed by the application.

Effect: Read-only

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
n_displaces returns length of list of names.
names returns list of names.

include <rnd_api.hxx>

outcome api_rh_get_displace_status ( RH_MATERIAL *  material,
logical &  status 
)

Gets the status of a material's displacement component.



Role: This API obtains the status of a material's displacement shader. If the status of a displacement shader is TRUE, the entity renders with displacement for those rendering modes that support displacement.

Effect: Read-only

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
material material to be queried.
status returns displacement status.

include <rnd_api.hxx>

outcome api_rh_get_entity_rgb ( ENTITY *  ent,
rgb_color &  color,
logical  inherit,
logical &  found 
)

Gets the RGB color of an entity.



Role: Searches the entity for one of four color attributes. Color precendence is as follows:
ATTRIB_RGB
ATTRIB_COL
ATTRIB_RENDER
ATTRIB_IGES_COLOR

If none of these attributes are found on the given entity and the inherit flag is set, the given entity's owner is examined in the same manner and so on up the hierarchy.

If no color attribute is found, the 'found' flag will be FALSE and the color <-1, -1, -1> is returned. (A color of <-1, -1, -1> means that a color is not specified for the given entity.)

Effect: Read-only

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
ent entity to change.
color color returned.
inherit inherit color from owner?
found Flag indicating that the color was explicitly set.

include <rnd_api.hxx>

outcome api_rh_get_environment_map ( RH_ENVIRONMENT_MAP *&  map  ) 

Gets the current environment map.



Role: The API returns NULL if the map is not set.

Effect: Read-only

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
map returned environment map

include <rnd_api.hxx>

outcome api_rh_get_foreground ( RH_FOREGROUND *&  foreground  ) 

Gets the current foreground.



Role: This API gets the current foreground shader used by the Rendering Base Component as a post processing step in the shader pipeline.The current foreground may be NULL, in which case, no post processing is performed.

Effect: Read-only

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
foreground returns foreground to be queried.

include <rnd_api.hxx>

outcome api_rh_get_foreground_args ( RH_FOREGROUND *  foreground,
const char *&  name,
int &  no_of_args,
const char **&  arg_names,
Render_Arg *&  arg_values 
)

Gets the arguments of a foreground.



Role: Each foreground has a list of named arguments. The number and names of those arguments depend on the type of foreground.Access the value of each argument via the Render_Arg class.

This API returns the name of the foreground type with two lists containing the names and values of those arguments. All returned pointer values point to internal data structures.

For efficiency, these values are not copied when the function is called.The application should not free the memory pointed to by those pointers. In the case of Render_Arg, the internal array is re-used by other inquiry functions. It is up to the application to copy those values, if required, before any subsequent inquiry functions.

Effect: Read-only

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
foreground foreground to be queried.
name returns name of foreground type.
no_of_args returns number of arguments.
arg_names returns array of argument names.
arg_values returns array of arguments.

include <rnd_api.hxx>

outcome api_rh_get_foreground_types ( int &  n_foregrounds,
const char **&  names 
)

Gets a list of valid foreground type names.



Role: This API points to a list of valid RH_FOREGROUND type names. The list should not be freed by the application.

Effect: Read-only

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
n_foregrounds returns number of foregrounds.
names returns list of names.

include <rnd_api.hxx>

outcome api_rh_get_highlight_rgb ( rgb_color &  color  ) 

Gets the RGB color used to highlight entities.



Role: This API returns the RGB color used to highlight entities.

Effect: Read-only

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
color highlight_rgb.

include <rnd_api.hxx>

outcome api_rh_get_light_args ( RH_LIGHT *  light,
const char *&  name,
int &  no_of_args,
const char **&  arg_names,
Render_Arg *&  arg_values 
)

Gets the arguments of a light.



Role: Each light has a list of named arguments. The number and names of those arguments depend on the type of light. Access the value of each argument via the Render_Arg class.

This API returns the name of the light type with two lists containing the names and values of those arguments. All returned pointer values point to internal data structures.

For efficiency, these values are not copied when the API is called. The application should not free the memory pointed to by those pointers. In the case of Render_Arg, the internal array is re-used by other inquiry functions. It is up to the application to copy those values, if required, before any subsequent inquiry functions.

Effect: Read-only

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
light light to be queried.
name returns name of light type.
no_of_args returns number of arguments.
arg_names returns array of argument names.
arg_values returns array of arguments.

include <rnd_api.hxx>

outcome api_rh_get_light_list ( ENTITY_LIST &  lights  ) 

Gets the contents of the active light list.



Role: The Rendering Base Component maintains an internal list of active lights that are used as light sources when an image is rendered.This API gets a copy of the elements of that list. At least one RH_LIGHT must reside in the active light list; otherwise, shaded entities are not visible. The API adds entries to the ENTITY_LIST provided by the application developer. It is up to the application to clean out the list.

Effect: Read-only

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
lights returns list of light entities, expected to be empty when specified to function.

include <rnd_api.hxx>

outcome api_rh_get_light_state ( RH_LIGHT *  light,
logical *  on_off 
)

Gets the on/off state of light.



Role: This API gets the active state of the RH_LIGHT entity.

Effect: Read-only

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
light light to be queried.
on_off returns on/off state of light.

include <rnd_api.hxx>

outcome api_rh_get_light_types ( int &  n_types,
const char **&  names 
)

Gets a list of valid light type names.



Role: The list should not be freed by the application.

Effect: Read-only

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
n_types returns number of types of lights.
names returns list of names.

include <rnd_api.hxx>

outcome api_rh_get_material ( ENTITY *  entity,
RH_MATERIAL *&  material 
)

Gets the material attached to an entity.



Role: This API gets the material attached to an entity. Geometric entities must be of the type BODY, LUMP, SHELL, or FACE.

Effect: Read-only

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
entity entity to be queried.
material returns material attached to entity.

include <rnd_api.hxx>

outcome api_rh_get_material_color ( ENTITY *  entity,
double &  red,
double &  green,
double &  blue,
logical &  found 
)

Gets the material color associated with a geometric entity.



Role: This API returns the material color attached to an entity. Geometric entities must be of the type BODY, LUMP, SHELL, or FACE.

The given material might not have a color assigned. In this case, the "found" argument will be FALSE.

Effect: Read-only

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
entity entity.
red returns red color value.
green returns green color value.
blue returns blue color value.
found returns TRUE if given material has been assigned a color, FALSE if no color has been assigned.

include <rnd_api.hxx>

outcome api_rh_get_material_reflection ( ENTITY *  entity,
double &  ambient,
double &  diffuse,
double &  specular,
double &  exponent 
)

Gets the material reflection properties associated with a geometric entity.



Role: This API gets the material reflection properties (if any) associated with a geometric entity. Geometric entities must be of the type BODY, LUMP, SHELL, or FACE.

Effect: Read-only

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
entity entity.
ambient returns ambient reflection.
diffuse returns diffuse reflection.
specular returns specular reflection.
exponent returns exponent value.

include <rnd_api.hxx>

outcome api_rh_get_material_texture ( ENTITY *  entity,
const char *&  tex_name 
)

Gets the material texture associated with a geometric entity.



Role: Geometric entities must be of the type BODY, LUMP, SHELL, or FACE.

Effect: Read-only

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
entity entity.
tex_name returns type of texture.

include <rnd_api.hxx>

outcome api_rh_get_material_transp ( ENTITY *  entity_list,
double &  transp 
)

Gets the material transparency associated with a geometric entity.



Role: This API gets the material transparency associated with a geometric entity. Geometric entities must be of the type BODY, LUMP, SHELL, or FACE.

Effect: Read-only

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
entity_list list of entities.
transp returns transparency value (0 is opaque; 1 is transparent).

include <rnd_api.hxx>

outcome api_rh_get_output_mode ( Output_Mode &  output_mode  ) 

Gets the current output mode.



Role: Refer to the chapter on Output Modes for a list of applicable modes.

Effect: Read-only

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
output_mode returns output mode.

include <rnd_api.hxx>

outcome api_rh_get_reflect_comp ( RH_MATERIAL *  material,
const char *&  name,
int &  no_of_args,
const char **&  arg_names,
Render_Arg *&  arg_values 
)

Gets the arguments of a material's reflectance component.



Role: Each material reflectance component has a list of named arguments. The number and names of those arguments depend on the type of reflectance component. Access the value of each argument via the Render_Arg class.

This API returns the name of the reflectance component type with two lists containing the names and values of those arguments. All returned pointer values point to internal data structures.

For efficiency, these values are not copied when the API is called. The application should not free the memory pointed to by those pointers. In the case of Render_Arg, the internal array is re-used by other inquiry functions. It is up to the application to copy those values, if required, before any subsequent inquiry functions.

Effect: Read-only

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
material material to be queried.
name returns name of reflectance component type.
no_of_args returns number of arguments.
arg_names returns array of argument names.
arg_values returns array of arguments.

include <rnd_api.hxx>

outcome api_rh_get_reflect_comp_list ( int &  n_reflects,
const char **&  names 
)

Gets a list of valid reflectance component names.



Role: This API points to a list of valid RH_MATERIAL reflectance component names. The list should not be freed by the application.

Effect: Read-only

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
n_reflects returns number of names.
names returns list of names.

include <rnd_api.hxx>

outcome api_rh_get_reflect_status ( RH_MATERIAL *  material,
logical &  status 
)

Gets the status of a material's reflection component.



Role: This API obtains the status of a material's reflection shader. If the status of a reflection shader is on (TRUE), the RH_MATERIAL renders with reflections for those rendering modes that support reflection.

Effect: Read-only

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
material shader to query.
status returns on/off shader status.

include <rnd_api.hxx>

outcome api_rh_get_render_mode ( Render_Mode &  render_mode  ) 

Gets the current render mode.



Role: Refer to the chapter on Render Modes for a list of applicable modes.

Effect: Read-only

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
render_mode returns render mode.

include <rnd_api.hxx>

outcome api_rh_get_resolution ( int &  width,
int &  height,
double &  pixel_aspect_ratio,
double &  image_scale 
)

Gets the default screen faceting resolution controls.



Effect: Read-only

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
width returns image space width.
height returns image space height.
pixel_aspect_ratio returns aspect ratio in pixels.
image_scale returns scale of the image.

include <rnd_api.hxx>

outcome api_rh_get_sidedness ( ENTITY *  entity,
int &  sides 
)

Gets the sidedness of an entity.



Role: Geometric entities must be of the type BODY, LUMP, SHELL, or FACE. If sides is 2, the entity is treated as double-sided for rendering. If sides is 1, the entity is treated as single-sided for rendering. If sides is 0, the entity has no sidedness set, and it inherits sidedness from its parent.

Effect: Read-only

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
entity entity to be queried.
sides returns sidedness.

include <rnd_api.hxx>

outcome api_rh_get_sub_image ( int &  left,
int &  right,
int &  top,
int &  bottom 
)

Gets the pixel coordinates of the region of interest on a screen.



Effect: Read-only

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
left returns left side.
right returns right side.
top returns top.
bottom returns bottom.

include <rnd_api.hxx>

outcome api_rh_get_texture_space ( ENTITY *  entity,
RH_TEXTURE_SPACE *&  texture_space 
)

Gets the texture space attached to an entity.



Role: This API gets the texture space attached to an entity. Geometric entities must be of the type BODY, LUMP, SHELL, or FACE.

Effect: Read-only

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
entity entity to be queried.
texture_space returns the new texture space.

include <rnd_api.hxx>

outcome api_rh_get_texture_space_args ( RH_TEXTURE_SPACE *  texture_space,
const char *&  name,
int &  no_of_args,
const char **&  arg_names,
Render_Arg *&  arg_values 
)

Gets the arguments of a texture space.



Role: Each texture space has a list of named arguments. The number and names of those arguments depend on the type of texture_space. Access the value of each argument via the Render_Arg class.

This API returns the name of the texture_space type with two lists containing the names and values of those arguments. All returned pointer values point to internal data structures.

For efficiency, these values are not copied when the function is called. The application should not free the memory pointed to by those pointers. In the case of Render_Arg, the internal array is re-used by other inquiry functions. It is up to the application to copy those values, if required, before any subsequent inquiry functions.

Effect: Read-only

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
texture_space texture space to be queried.
name returns name of texture space type.
no_of_args returns number of arguments.
arg_names returns array of argument names.
arg_values returns array of arguments.

include <rnd_api.hxx>

outcome api_rh_get_texture_space_types ( int &  n_types,
const char **&  names 
)

Gets a list of valid texture space type names.



Role: This API points to a list of valid RH_TEXTURE_SPACE type names. The list should not be freed by the application.

Effect: Read-only

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
n_types returns number of names.
names returns list of names.

include <rnd_api.hxx>

outcome api_rh_get_transp_comp ( RH_MATERIAL *  material,
const char *&  name,
int &  no_of_args,
const char **&  arg_names,
Render_Arg *&  arg_values 
)

Gets the arguments of a material's transparency component.



Role: Each material transparency component has a list of named arguments. The number and names of those arguments depend on the type of transparency component.Access the value of each argument via the Render_Arg class.

This API returns the name of the transparency component type with two lists containing the names and values of those arguments. All returned pointer values point to internal data structures.

For efficiency, these values are not copied when the API is called. The application should not free the memory pointed to by those pointers. In the case of Render_Arg, the internal array is re-used by other inquiry functions. It is up to the application to copy those values, if required, before any subsequent inquiry functions.

Effect: Read-only

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
material material to be queried.
name returns name of transparency component type.
no_of_args returns number of arguments.
arg_names returns array of argument names.
arg_values returns array of arguments.

include <rnd_api.hxx>

outcome api_rh_get_transp_comp_list ( int &  n_transparencies,
const char **&  names 
)

Gets a list of valid transparency component names.



Role: The list should not be freed by the application.

Effect: Read-only

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
n_transparencies returns number of transparencies.
names returns list of names.

include <rnd_api.hxx>

outcome api_rh_get_transp_status ( RH_MATERIAL *  material,
logical &  status 
)

Gets the status of a material's transparency component.



Role: If the status of a transparency shader is on (TRUE), the RH_MATERIAL renders with transparency for those rendering modes that support transparency.

Effect: Read-only

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
material shader to be queried.
status returns on/off status of shader.

include <rnd_api.hxx>

outcome api_rh_get_view ( SPAposition &  from_point,
SPAposition &  to_point,
SPAvector &  view_up_vector,
Projection_Type &  projection,
double &  field_of_view 
)

Gets the view parameters that affect view-dependent faceting.



Effect: Read-only

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
from_point returns from point.
to_point returns to point.
view_up_vector returns normal to view.
projection returns type of projection.
field_of_view returns field of view.

include <rnd_api.hxx>

outcome api_rh_initialise (  ) 

Initializes the renderer.



Role: This API initializes the internal data structures required by the renderer. Call this API before any other Rendering Base Component functions.

Effect: System routine

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

include <rnd_api.hxx>

outcome api_rh_initialise_image_utilities (  ) 

Initializes the Image Utilities Library.



Role: This function initializes the use of the Image Format Utility Library. Call this function before any others in the Image Format Utility Library. Call LwTerminateImageUtilities to terminate the use of the library.Call this function when the rendering session is initiated with api_rh_initialise.

Effect: System routine

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

include <rnd_api.hxx>

outcome api_rh_initialise_supl_shaders (  ) 

Initializes the supplemental shaders.



Role: When the Rendering Base Component is initialized, the shaders supplied with the Core Shader Library are automatically initialized.To initialize the larger set of shaders located in the Supplementary Shader Library,call api_rh_initialise_supl_shaders.

Effect: System routine

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

include <rnd_api.hxx>

outcome api_rh_read_lightworks_image ( FILE *  fp,
LwInt32  channels,
LwInt32  width,
LwInt32  height,
LwNat8 *  data 
)

Gets the LightWorks image for display.



Effect: System routine

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
fp filename.
channels color channel.
width image width.
height image height.
data image data.

include <rnd_api.hxx>

outcome api_rh_read_lightworks_image_size ( FILE *  fp,
LwInt32 *  width,
LwInt32 *  height 
)

Gets the LightWorks image size.



Role: Gets the LightWorks image size.

Effect: System routine

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
fp filename.
width image width.
height image height.

include <rnd_api.hxx>

outcome api_rh_render_cube_environment ( ENTITY_LIST const &  entities,
int  resolution,
SPAposition const &  view_point,
RH_ENVIRONMENT_MAP *&  map 
)

Creates an environment map from a list of entities.



Role: Environment maps simulate reflections on objects caused by other objects in the scene and by an external environment. This API supports inter-object reflections by computing an environment map from a list of entities. The environment map is represented internally by six square images of a given resolution. Each image represents a perspective view as seen from the given view_point in each of the six orthogonal directions.

Effect: Changes model

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
entities list of entities from which the environment map is to be computed.
resolution resolution.
view_point view point.
map returns new environment map.

include <rnd_api.hxx>

outcome api_rh_render_entities ( ENTITY_LIST const &  entities,
logical  clear_screen = TRUE 
)

Renders a list of entities.



Role: This API renders one or more geometric entities of the type BODY, LUMP, SHELL, or FACE. Facet the entities before rendering.

Effect: System routine

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
entities entities to be rendered.
clear_screen clear image before rendering.

include <rnd_api.hxx>

outcome api_rh_set_background ( RH_BACKGROUND *  background  ) 

Sets the current background.



Role: This API sets the current background shader used by the Rendering Base Component to color pixels that are not covered by the surface of an object. If the current background shader is NULL, the background is black.

Effect: Changes model

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
background background to set.

include <rnd_api.hxx>

outcome api_rh_set_background_arg ( RH_BACKGROUND *  background,
const char *  arg_name,
const Render_Arg &  value 
)

Sets an argument for a background.



Role: This API sets arguments controlling the background specified by name. name must correspond to one of the supported arguments for the type of background associated with RH_BACKGROUND.The underlying argument type depends on the argument set with the Render_Arg class.

Effect: Changes model

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
background background.
arg_name name of argument.
value argument value.

include <rnd_api.hxx>

outcome api_rh_set_clipping ( double  near_clipping_plane,
double  far_clipping_plane 
)

Sets the near and far clipping planes for faceting.



Role: When view-dependent refinements are used, objects beyond the far planes or in front of the near planes are not faceted.Objects that cross the clipping planes facet correctly only in the region between the planes.

Effect: Changes model

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
near_clipping_plane near clipping plane.
far_clipping_plane far clipping plane.

include <rnd_api.hxx>

outcome api_rh_set_color_arg ( RH_MATERIAL *  material,
const char *  arg_name,
const Render_Arg &  value 
)

Sets an argument of a material's color component.



Role: This API sets arguments controlling the color component specified by name. name must correspond to one of the supported arguments for the type of color component associated with the RH_MATERIAL. The underlying argument type depends on the argument set with the Render_Arg class.

Effect: Changes model

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
material material.
arg_name name of argument.
value argument value.

include <rnd_api.hxx>

outcome api_rh_set_color_comp ( RH_MATERIAL *  material,
const char *  color_shader_name 
)

Sets the color component of a material.



Role: An RH_MATERIAL comprises four component shaders: a color shader, a displacement shader, a reflectance shader, and a transparency shader. When an instance of an RH_MATERIAL is created, it is created with a default set of component shaders. This API changes the type of the color shader to name.

Errors: The name of color component is not one of the supported types.

Effect: Changes model

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
material material.
color_shader_name name of color shader.

include <rnd_api.hxx>

outcome api_rh_set_control_variable ( Render_Control_Var  var,
const Render_Arg &  value 
)

Sets a render control variable.



Role: The value given depends on the control variable being affected. Refer to the chapter on Control Variables for a list of all control variable names.

Effect: System routine

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
var control variable.
value control value.

include <rnd_api.hxx>

outcome api_rh_set_conversion_colour_map ( LwInt32  r_max,
LwInt32  g_max,
LwInt32  b_max,
LwInt32  r_mult,
LwInt32  g_mult,
LwInt32  b_mult,
LwInt32  base_index 
)

Sets the color map for conversion.



Role: This function describes the color map of the output device, and it takes the form of an RGB cube.An RGB cube is a 3D array containing an ordered spectrum of colors. The subscripts of an RGB cube are values representing the respective amounts of each red, green, and blue color component of a particular color.

Images are displayed on a display device using a color-map containing the spectrum of colors described by the RGB cube.

Display devices' color-maps are normally 1D arrays, with the subscript being a color-map index. r_mult, g_mult, and b_mult are the multipliers for the respective RGB cube subscripts used to build a color-map index.The color-map index of a color within the RGB cube, with RGB cube subscript levels of r, g, and b are 

base_index + r  x  r_mult + g  x g_mult + b  x  b_mult
When LwConvertRGBScanline or LwConvertRGBFloatScanline is called, the pixels' colors are converted into color-map indexes within the RGB cube.

This function's parameters describe the layout of a 3D array representing the RGB cube. Set r_max, g_max, and b_max to the maximum number of different shades of each primary color in the RGB cube.Set r_mult, g_mult, and b_mult to the multipliers for the respective components within the RGB cube when converting RGB levels into color-map indexes.Set base_index to the start index of the RGB cube within the color-map.For a standard 8-bit display device, the values are typically: 
 r_max = 5, g_max = 5, b_max = 5, r_mult = 36, g_mult = 6, b_mult = 1
describing a 216-color cube with six levels of each color component.Set base_index to the index of the first entry of the cube in the map.

For the grey-scale conversion method only r_max, r_mult, and base_index are significant.

For the monochrome conversion method, only base_index is significant.

Set the conversion color-map for an image before calling LwConvertImageStart. This function is ignored if it is called between calls to LwConvertImageStart and LwConvertImageEnd.

The default conversion color-map set by LwInitialiseImageUtilities is a 6 x 6 x 6 RGB cube with parameters of 
 r_max = 5, g_max = 5, b_max = 5, r_mult = 36, g_mult = 6, b_mult = 1, and
 base_index = 0
.

Effect: System routine

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
r_max red color map index.
g_max green color map index.
b_max blue color map index.
r_mult red color multiplier.
g_mult green color multiplier.
b_mult blue color multiplier.
base_index base index.

include <rnd_api.hxx>

outcome api_rh_set_conversion_method ( LwConversionMethod  method  ) 

Sets the method for conversion.



Role: This function sets the image conversion method used by LwConvertRGBScanline and LwConvertRGBFloatScanline for subsequent images.method must be one of the following conversion method types:

LW_CONVERSION_TC_DITHER adds random dither (noise) separately to each pixel color component in the image data.The amplitude of the dither is half a quantization level.Use the true-color dither image conversion on true-color devices.

LW_CONVERSION_FS_RGB distributes the color errors between the image color of a pixel and the nearest color to it in the RGB cube across the image to minimize any color artifacts.The process produces good color reproduction, and it is the recommended image conversion method for the higher-quality rendering modes on pseudo-color displays.This conversion method is based on the Floyd-Steinberg algorithm.This is the default conversion method.

LW_CONVERSION_O_DITHER_RGB screens the pixel colors by a color dithering matrix.This increases the color resolution of the device at the expense of reducing the spatial resolution.The ordered dither image conversion method is faster than the Floyd-Steinberg method, but it tends to introduce a noticeable pattern across the image.Use it as an alternative conversion method to LW_CONVERSION_FS_RGB with simpler rendering modes, such as flat and Gouraud, where speed is more important than image quality.

LW_CONVERSION_GREYSCALE converts the color of a pixel into a grey level using the standard NTSC color to luminance conversion.This luminance value is the basis for the index assigned to the pixel.

luminance = 0.3r + 0.59g + 0.11b

This method assumes that the grey-scale ramp is defined by the red channel of the color map defined by calling LwSetConversionColourMap.This conversion method applies to grey-scale display devices.

LW_CONVERSION_FS_MONOCHROME distributes errors in the colors between the image color of a pixel and the black or white pixel value area across the image to minimize any artifacts.The conversion is based on the Floyd-Steinberg algorithm.This image conversion method provides good image reproduction on 1-bit or bit-mapped display devices.

LW_CONVERSION_FS_DITHER_RGB augments a color Floyd-Steinberg error distribution with the addition of random noise to the input colors.For some images, the standard color Floyd-Steinberg method creates artifacts in the image, and the addition of noise helps to minimize them. Generally, the improvements to the output image are not enough to justify the extra time spent by this method.

LW_CONVERSION_DITHER_RGB adds a random noise to the image before quantization into the color map. The dither amplitude is equal to one quantization level. This improves average image quality at the expense of some localized noise.

LW_CONVERSION_NEAREST_RGB quantizes pixel colors are quantized into the color map by selecting the nearest color in the map.For pseudo-color displays, this usually causes color banding in the image.

Call this function before calling LwConvertImageStart. Do not call this function during the conversion of an image, which is initiated by LwConvertImageStart and terminated by LwConvertImageEnd.The default method is set to LW_CONVERSION_FS_RGB when LwInitialiseImageUtilities is called.

Effect: System routine

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
method conversion method.

include <rnd_api.hxx>

outcome api_rh_set_default_background_rgb ( rgb_color  color  ) 

Gets the default background RGB color for new toolkit graphics windows.



Effect: Read-only

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
color returned color.

include <rnd_api.hxx>

outcome api_rh_set_default_edge_rgb ( rgb_color  color  ) 

Gets the default RGB color for edge entities.



Effect: Read-only

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
color returned color.

include <rnd_api.hxx>

outcome api_rh_set_default_face_rgb ( rgb_color  color  ) 

Gets the default RGB color for new face entities.



Effect: Read-only

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
color returned color.

include <rnd_api.hxx>

outcome api_rh_set_default_rgb ( rgb_color  color  ) 

Modifies the default RGB color for newly-created entities.



Role: Use the changed color to display entities with no color attribute. It is also used when color is -1 in api_rh_set_entity_color.

Effect: Read-only

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
color color to set.

include <rnd_api.hxx>

outcome api_rh_set_default_vertex_rgb ( rgb_color  color  ) 

Gets the default RGB color for new vertex entities.



Effect: Read-only

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
color returned color.

include <rnd_api.hxx>

outcome api_rh_set_displace_arg ( RH_MATERIAL *  material,
const char *  arg_name,
const Render_Arg &  value 
)

Sets an argument of a material's displacement component.



Role: This API sets arguments controlling the displacement component specified by name. name must correspond to one of the supported arguments for the type of displacement component associated with the RH_MATERIAL.The underlying argument type depends on the argument set with the Render_Arg class.

Effect: Changes model

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
material material.
arg_name name of argument.
value argument value.

include <rnd_api.hxx>

outcome api_rh_set_displace_comp ( RH_MATERIAL *  material,
const char *  name 
)

Sets a material's displacement component.



Role: An RH_MATERIAL comprises four component shaders: a color shader, a displacement shader, a reflectance shader, and a transparency shader. When an instance of an RH_MATERIAL is created, it is created with a default set of component shaders. This API changes the type of the displacement shader to name.

Errors: The name of the displacement component is not one of the supported types.

Effect: Changes model

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
material material.
name name of displacement shader.

include <rnd_api.hxx>

outcome api_rh_set_displace_status ( RH_MATERIAL *  material,
logical  status 
)

Sets the status of a material's displacement component.



Role: This API enables or disables the defined displacement component of a material. The API uses the displacement component if its status is TRUE; otherwise, it is ignored.

Effect: Changes model

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
material material to set.
status TRUE (displacement on) or FALSE (displacement off).

include <rnd_api.hxx>

outcome api_rh_set_entity_rgb ( ENTITY *  ent,
rgb_color  color 
)

Modifies the RGB color index of an ENTITY.



Role: Change the entity color by adding or changing an ATTRIB_RGB. Also, if the entity is in the display list, its color is changes. Any ATTRIB_COL is removed from the entity.

Effect: Changes model

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
ent entity to modify.
color new color index.

include <rnd_api.hxx>

outcome api_rh_set_environment_map ( RH_ENVIRONMENT_MAP *  map  ) 

Sets the current environment map.



Role: This API sets the renderer to use a particular cube environment map during rendering. If the current mode of rendering and current shaders use reflectance, the environment map generates a single level of reflections.Environment maps are generated by reading six raster images supplied by the application using api_rh_create_cube_environment or generated by rendering six images from the entity list using api_rh_render_cube_environment.

Effect: Changes model

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
map environment map to set.

include <rnd_api.hxx>

outcome api_rh_set_foreground ( RH_FOREGROUND *  foreground  ) 

Sets the current foreground.



Role: This API sets the current foreground shader used by the Rendering Base Component to color pixels that are not covered by the surface of an object. If the current foreground shader is NULL, the foreground is black.

Effect: Changes model

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
foreground foreground to set.

include <rnd_api.hxx>

outcome api_rh_set_foreground_arg ( RH_FOREGROUND *  foreground,
const char *  arg_name,
const Render_Arg &  value 
)

Sets an argument of a foreground.



Role: This API sets arguments controlling the foreground specified by name. name must correspond to one of the supported arguments for the type of foreground associated with RH_FOREGROUND.The underlying argument type depends on the argument set with the Render_Arg class.

Effect: Changes model

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
foreground foreground.
arg_name name of argument.
value argument value.

include <rnd_api.hxx>

outcome api_rh_set_highlight_rgb ( rgb_color  color  ) 

Modifies the RGB color used to highlight entities.



Role: This API changes the color index used to display highlighted entities.

Effect: Changes model

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
color new color index.

include <rnd_api.hxx>

outcome api_rh_set_light_arg ( RH_LIGHT *  light,
const char *  arg_name,
const Render_Arg &  value 
)

Sets an argument for a light.



Role: This API sets sets arguments controlling the light specified by name.name must correspond to one of the supported arguments for the type of light associated with RH_LIGHT. The underlying argument type depends on the argument set with the Render_Arg class.

Effect: Changes model

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
light light.
arg_name name of argument.
value argument value.

include <rnd_api.hxx>

outcome api_rh_set_light_list ( ENTITY_LIST const &  lights  ) 

Sets the active light list.



Role: The Rendering Base Component maintains an internal list of active lights that are used as light sources when an image is rendered.This API sets the elements of that list. At least one RH_LIGHT must reside in the active light list; otherwise, shaded entities are not visible.

Effect: System routine

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
lights list of lights.

include <rnd_api.hxx>

outcome api_rh_set_light_state ( RH_LIGHT *  light,
logical  on_off 
)

Sets the on/off state for a light.



Role: This API sets the active state of the RH_LIGHT entity.

Effect: Changes model

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
light light.
on_off on/off state for the light.

include <rnd_api.hxx>

outcome api_rh_set_material ( ENTITY_LIST const &  entities,
RH_MATERIAL *  material = (RH_MATERIAL *) NULL 
)

Attaches a material to a list of entities.



Role: Geometric ENTITYs must be of the type BODY, LUMP, SHELL, or FACE.

Effect: Changes model

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
entities entities to which to attach material.
material material to attach.

include <rnd_api.hxx>

outcome api_rh_set_material_color ( ENTITY_LIST const &  entities,
double  red,
double  green,
double  blue 
)

Sets the color of a material associated with a geometric entity.



Role: This API sets the color of a material associated with a geometric entity. Geometric entities must be of the type BODY, LUMP, SHELL, or FACE.

Effect: Changes model

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
entities list of entities.
red red color value.
green green color value.
blue blue color value.

include <rnd_api.hxx>

outcome api_rh_set_material_reflection ( ENTITY_LIST const &  entity_list,
double  ambient,
double  diffuse,
double  specular,
double  exponent 
)

Sets the reflection properties in the material associated with a geometric entity.



Role: This API sets the reflection properties in the material associated with a geometric entity.Geometric entities must be of the type BODY, LUMP, SHELL, or FACE.

Effect: Changes model

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
entity_list list of entities to be set.
ambient ambient light value.
diffuse diffuse light value.
specular specular light value.
exponent exponent value.

include <rnd_api.hxx>

outcome api_rh_set_material_texture ( ENTITY_LIST const &  entity_list,
const char *  tex_name 
)

Sets the texture file name in the material associated with a geometric entity.



Role: This API sets the texture file name in the material associated with a geometric entity. Geometric entities must be of the type BODY, LUMP, SHELL, or FACE.

Effect: Changes model

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
entity_list list of entities to be set.
tex_name texture file name.

include <rnd_api.hxx>

outcome api_rh_set_material_transp ( ENTITY_LIST const &  entity_list,
double  transp 
)

Sets the transparency properties in the material associated with a geometric entity.



Role: Geometric entities must be of the type BODY, LUMP, SHELL, or FACE.

Effect: Changes model

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
entity_list list of entities to be set.
transp transparency value ( 0 is opaque; 1 is transparent).

include <rnd_api.hxx>

outcome api_rh_set_output_mode ( Output_Mode  output_mode  ) 

Sets the current rendering output mode.



Role: Any subsequent rendering operations output scan lines in the format governed by that mode. Refer to the chapter on Output Modes for a list of applicable output modes.

Effect: System routine

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
output_mode output mode to set.

include <rnd_api.hxx>

outcome api_rh_set_reflect_arg ( RH_MATERIAL *  material,
const char *  arg_name,
const Render_Arg &  value 
)

Sets an argument of a material's reflectance component.



Role: This API sets arguments controlling the reflectance component specified by name. name must correspond to one of the supported arguments for the type of reflectance component associated with the RH_MATERIAL.The underlying argument type depends on the argument set with the Render_Arg class.

Effect: Changes model

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
material material.
arg_name name of argument.
value argument value.

include <rnd_api.hxx>

outcome api_rh_set_reflect_comp ( RH_MATERIAL *  material,
const char *  reflectance_shader_name 
)

Sets a material's reflectance component.



Role: An RH_MATERIAL comprises four component shaders; a color shader, a displacemen t shader, a reflectance shader, and a transparency shader. When an instance of an RH_MATERIAL is created, it is created with a default set of component shaders.This API changes the type of the reflectance shader to the specified name.

Errors: The name of the reflectance component is not one of the supported types.

Effect: Changes model

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
material material.
reflectance_shader_name name of reflectance shader.

include <rnd_api.hxx>

outcome api_rh_set_reflect_status ( RH_MATERIAL *  material,
logical  status 
)

Sets a material's reflection status.



Role: This API enables or disables a material's reflection shader. The reflection component is used if its status is TRUE; otherwise, it is ignored.

Effect: Changes model

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
material material.
status toggle on/off.

include <rnd_api.hxx>

outcome api_rh_set_render_mode ( Render_Mode  render_mode  ) 

Sets the current render mode.



Role: Any subsequent rendering operations use the specified mode. Refer to the chapter on Render Modes for a list of applicable modes.

Effect: System routine

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
render_mode render mode to set.

include <rnd_api.hxx>

outcome api_rh_set_resolution ( int  width,
int  height,
double  pixel_aspect_ratio,
double  image_scale 
)

Sets the default screen faceting resolution controls.



Role: This API sets the default screen faceting resolution controls.

Effect: System routine

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
width image space width.
height image space height.
pixel_aspect_ratio aspect ratio in pixels.
image_scale scale of the image.

include <rnd_api.hxx>

outcome api_rh_set_sidedness ( ENTITY_LIST const &  entities,
int  sides 
)

Sets the sidedness of faces of entities.



Role: This API defines the surface of an entity to be single-sided or double-sided for rendering purposes.This may be used to help visualize faces of nonmanifold objects where it is desirable to view both sides of a face.Geometric entities must be of the type BODY, LUMP, SHELL, or FACE. A two-sided face is always treated as double-sided.

Effect: Changes model

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
entities entities to have sidedness set.
sides 0 (sidedness undefined), 1 (single-sided), or 2 (double-sided).

include <rnd_api.hxx>

outcome api_rh_set_sub_image ( int  left,
int  right,
int  top,
int  bottom 
)

Sets the region of image importance within a screen image.



Role: This API sets the region of image importance within a screen image.

Effect: Changes model

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
left left side.
right right side.
top top.
bottom bottom.

include <rnd_api.hxx>

outcome api_rh_set_texture_space ( ENTITY_LIST const &  entities,
RH_TEXTURE_SPACE *  texture_space = (RH_TEXTURE_SPACE *) NULL 
)

Attaches a texture space to a list of entities.



Role: This API sets the texture space associated with an entity list. Each ENTITY must be of the type BODY, LUMP, SHELL, or FACE.

Effect: Changes model

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
entities entities to have texture space attached.
texture_space given texture space.

include <rnd_api.hxx>

outcome api_rh_set_texture_space_arg ( RH_TEXTURE_SPACE *  texture_space,
const char *  arg_name,
const Render_Arg &  value 
)

Sets an argument for a texture space.



Role: This API sets arguments controlling the texture space specified by name. name must correspond to one of the supported arguments for the type of texture space associated with RH_TEXTURE_SPACE. The underlying argument type is depends on the argument set with the Render_Arg class.

Effect: Changes model

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
texture_space given texture space.
arg_name name of argument.
value argument value.

include <rnd_api.hxx>

outcome api_rh_set_transp_arg ( RH_MATERIAL *  material,
const char *  arg_name,
const Render_Arg &  value 
)

Sets an argument of a material's transparency component.



Role: This API sets arguments controlling the transparency component specified by name. name must correspond to one of the supported arguments for the type of transparency component associated with RH_MATERIAL. The underlying argument type depends on the argument set with the Render_Arg class.

Effect: Changes model

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
material material.
arg_name name of argument.
value argument value.

include <rnd_api.hxx>

outcome api_rh_set_transp_comp ( RH_MATERIAL *  material,
const char *  transparency_shader_name 
)

Sets a material's transparency component.



Role: An RH_MATERIAL comprises four component shaders: a color shader, a displacement shader, a reflectance shader, and a transparency shader. When an instance of an RH_MATERIAL is created, it is created with a default set of component shaders. This API changes the type of the transparency shader to the specified name.

Errors: The name of the transparency component is not one of the supported types.

Effect: Changes model

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
material material material.
transparency_shader_name name of transparency shader.

include <rnd_api.hxx>

outcome api_rh_set_transp_status ( RH_MATERIAL *  material,
logical  status 
)

Sets a material's transparency status.



Role: This API enables or disables a material's transparency shader. The transparency component is used if its status is TRUE; otherwise, it is ignored.

Effect: Changes model

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
material material.
status TRUE (transparency on) or FALSE (transparency off).

include <rnd_api.hxx>

outcome api_rh_set_view ( SPAposition  from_point,
SPAposition  to_point,
SPAvector  view_up_vector,
Projection_Type  projection,
double  field_of_view 
)

Sets the view parameters that affect view-dependent faceting.



Role: In view-dependent faceting, objects outside the field of view are left unfaceted, which is similar to treatment of objects outside of the clipping planes.

Effect: Changes model

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

Parameters:
from_point from point.
to_point to point.
view_up_vector normal to view.
projection given type of projection.
field_of_view field of view.

include <rnd_api.hxx>

outcome api_rh_terminate (  ) 

Terminates the renderer.



Role: This API destroys the internal data structures required by the renderer. It must be the final Rendering Base Component function call.

Effect: System routine

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

include <rnd_api.hxx>

outcome api_rh_terminate_image_utilities (  ) 

Terminates the use of the Image Format Utility Library.



Role: This function terminates the use of the Image Format Utility Library, and it must match a corresponding call to LwInitialiseImageUtilities. Any data structures that have been allocated by the library are de-allocated. Call this function when terminating a rendering session with api_rh_terminate.

Effect: System routine

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

include <rnd_api.hxx>

outcome api_terminate_rendering (  ) 

Terminates the rendering library.



Effect: System routine

Journal: Not Available

Product(s): 3D ACIS Exchange, 3D Viz Exchange, 3D ACIS Modeler

include <rnd_api.hxx>

NORENDER_ATTRIB* find_NORENDER_ATTRIB ( const ENTITY *  ent  ) 

Finds and returns a NORENDER_ATTRIB attached to an ENTITY.



Parameters:
ent entity pointer.

include <no_rend.hxx>

logical is_Background_Type ( const char *  type  ) 

Determines if a character string represents a legal background type.



Effect: Read-only.

Parameters:
type entity.

include <rh_util.hxx>

logical is_Color_Type ( const char *  type  ) 

Determines if a character string represents a legal color type.



Effect: Read-only

Parameters:
type string.

include <rh_util.hxx>

logical is_Displace_Type ( const char *  type  ) 

Determines if a character string represents a legal displacement type.



Effect: Read-only.

Parameters:
type string.

include <rh_util.hxx>

logical is_Foreground_Type ( const char *  type  ) 

Determines if a character string represents a legal foreground type.



Effect: Read-only

Parameters:
type string.

include <rh_util.hxx>

logical is_Light_Type ( const char *  type  ) 

Determines if a character string represents a legal light type.



Effect: Read-only

Parameters:
type string.

include <rh_util.hxx>

logical is_Reflect_Type ( const char *  type  ) 

Determines if a character string represents a legal reflection type.



Effect: Read-only

Parameters:
type string.

include <rh_util.hxx>

logical is_Texture_Space_Type ( const char *  type  ) 

Determines if a character string represents a legal texture space type.



Effect: Read-only

Parameters:
type string.

include <rh_util.hxx>

logical is_Transp_Type ( const char *  type  ) 

Determines if a character string represents a legal transparency type.



Effect: Read-only

Parameters:
type entity.

include <rh_util.hxx>

void remove_rbase_app_cb ( rbase_app_callback *  cb  ) 

Removes the callback.



Effect: System routine

Parameters:
cb given callback.

include <rbapp_cb.hxx>