SilverScreenAPI

PROPLIB_ENTRY

Structure

A data type that stores information about a property library entry.

struct PROPLIB_ENTRY

{

NAME property_name;

char description[256];

// =========================================

// STATES

// =========================================

// Surface property states

int s_rgb_set;

int s_pattern_name_set;

int s_pattern_rgb_set;

int s_pattern_scale_set;

// Edge property states

int e_rgb_set;

int e_width_set;

int e_style_name_set;

// Shading property states

int sh_ambient_set;

int sh_diffusion_set;

int sh_reflectance_set;

int sh_gloss_set;

int sh_spectral_rgb_set;

int sh_casts_a_shadow_set;

int sh_opacity_set;

int sh_reflection_set;

int sh_reflection_blur_set;

// Texture property states

int tx_path_set;

int tx_map_set;

int tx_mode_set;

int tx_width_set;

int tx_height_set;

int tx_rotation_set;

int tx_horzflip_set;

int tx_vertflip_set;

int tx_fullfit_set;

// Text property states

int t_font_set; // If this is set, t_style is set too.

int t_height_set;

int t_rotation_set;

int t_underscore_set;

int t_overscore_set;

int t_filled_set;

int t_aspect_set;

int t_spacing_set;

int t_slant_set;

// =========================================

// DATA

// =========================================

// Surface property data

RGB s_rgb;

NAME s_pattern_name;

RGB s_pattern_rgb;

double s_pattern_scale;

// Edge property data

RGB e_rgb;

USINT e_width;

NAME e_style_name;

// Shading property data

int sh_ambient;

int sh_diffusion;

int sh_reflectance;

int sh_opacity;

int sh_gloss;

RGB sh_spectral_rgb;

int sh_casts_a_shadow;

double sh_reflection;

double sh_reflection_blur;

// Texture property data

char tx_path[512];

int tx_map;

int tx_mode;

double tx_width;

double tx_height;

double tx_rotation;

int tx_horzflip;

int tx_vertflip;

int tx_fullfit;

// Text property data

char t_font[512];

USINT t_style;

double t_height;

double t_rotation;

int t_underscore;

int t_overscore;

int t_filled;

double t_aspect;

double t_spacing;

double t_slant;

};

Members

Member	Description
property_name	The name of the property library entry to which the data in this structure relates
description	A description of the property library entry to which the data in this structure relates
s_rgb	The surface color associated with the property library entry if s_rgb_set is non-zero.
s_pattern_name	The surface pattern name associated with the property library entry if s_pattern_name_set is non-zero.
s_pattern_rgb	The surface pattern color color associated with the property library entry if s_pattern_rgb_set is non-zero.
s_pattern_scale	The surface pattern scaling factor associated with the property library entry if s_pattern_scale_set is non-zero.
e_rgb	The edge color associated with the property library entry if e_rgb_set is non-zero.
e_width	The edge line width associated with the property library entry if e_width_set is non-zero.
e_style_name	The edge linestyle name associated with the property library entry if e_style_name_set is non-zero.
sh_ambient	The ambient light intensity [0-100] associated with the property library entry if sh_ambient_set is non-zero.
sh_diffusion	The diffuse light intensity [0-100] associated with the property library entry if sh_diffusion_set is non-zero.
sh_reflectance	The spectral light intensity [0-100] associated with the property library entry if sh_reflectance_set is non-zero.
sh_opacity	The degree of opaqueness [0-100] associated with the property library entry if sh_opacity_set is non-zero.
sh_gloss	The spectral light power associated with the property library entry if sh_gloss_set is non-zero.
sh_spectral_rgb	The spectral light color associated with the property library entry if sh_spectral_rgb_set is non-zero.
sh_casts_a_shadow	The light occlusion Boolean property associated with the property library entry if sh_casts_a_shadow_set is non-zero
sh_reflection	The degree of reflectivity [0.0 - 1.0] associated with the property library entry if sh_reflection is non-zero.
sh_reflection_blur	The degree to which reflections are blurred [0.0 - 1.0] associated with the property library entry if sh_reflection_blur_set is non-zero.
tx_path	The path to the texture associated with the property library entry if tx_path_set is non-zero.
tx_map	The texture mapping associated with the property library entry if tx_map_set is non-zero.
tx_mode	The texture mode associated with the property library entry if tx_mode_set is non-zero.
tx_width	The texture width (in inches) associated with the property library entry if tx_width_set is non-zero.
tx_height	The texture height (in inches) associated with the property library entry if tx_height_set is non-zero.
tx_rotation	The texture rotation angle (in degrees) associated with the property library entry if tx_rotation_set is non-zero.
tx_horzflip	The horizontal texture flip Boolean property associated with the property library entry if tx_horzflip_set is non-zero.
tx_vertflip	The vertical texture flip Boolean property associated with the property library entry if tx_vertflip_set is non-zero.
tx_fullfit	The stretch-to-fit Boolean property associated with the property library entry if tx_fullfit_set is non-zero.
t_font	The font name associated with the property library entry if t_font_set is non-zero.
t_style	The text style associated with the property library entry if t_font_set is non-zero.
t_height	The text height (in inches) associated with the property library entry if t_height_set is non-zero.
t_rotation	The text rotation angle (in degrees) associated with the property library entry if t_rotation_set is non-zero.
t_underscore	The text underscore value associated with the property library entry if t_underscore_set is non-zero.
t_overscore	The text overscore value associated with the property library entry if t_overscore_set is non-zero.
t_filled	The text fill Boolean property associated with the property library entry if t_filled_set is non-zero.
t_aspect	The text aspect ratio associated with the property library entry if t_aspect_set is non-zero.
t_spacing	The text spacing ratio associated with the property library entry if t_spacing_set is non-zero.
t_slant	The text slant angle (in degrees) associated with the property library entry if t_slant_set is non-zero.

Remarks

The property_name and description fields may be empty strings. This is the case when the PROPLIB_ENTRY structure was filled by get_bos_proplib, which reads properties directly from a BOS_NODE and not from a property library.

ssnodes.h

Help URL: http://www.yourdomain.com/help/index.html?proplib_entry.htm