SchemeExt:Phlv5:compute

From DocR21

Contents 1 Action 2 Filename 3 APIs 4 Syntax 5 Argument Types 6 Returns 7 Description 8 Arguments 9 Limitations 10 Examples

Action

Computes a hidden line view of the part.

Filename

scm/scmextcatia/phlv5/phlv5_scm.cpp

APIs

api_phlv5_compute

Syntax

(phlv5:compute [body-list] [token=0] [view=active] [phlv5-options=0] [color] [command-options] [acis-opts])

Argument Types

Argument	Scheme Data Type
body-list	wire-body
token	integer
view	view
phlv5-options	phlv5-options
color	color
command-options	string
acis-opts	acis-options

Returns

phlv5-data

Description

This extension computes the hidden line removal data for the given viewing parameters and list of bodies.

Note: The Scheme command phlv5:compute can be set to render the polyline data or the modeling curve returned from the PHLV5_EDGE. To render the polyline data, set this global ACIS option to false (option:set "phlv5_render_curves" #f).

Arguments

• body-list specifies a list of bodies.
• token (optional) is an integer index. The default value is 0. When token is 0, hidden line data is computed for drawing, but it is not stored in attributes attached to the bodies. If token is non-zero, the data is stored on the model as attributes and identified by a token. Existing attributes identified by the same token are replaced.
• view specifies a view. If view is not specified, active view is taken.
• phlv5-options is optional and is an object containing hidden line options.
• acis-opts is optional and specifies versioning and journaling options.
• color is optional and specifies the color used to draw hidden lines, such as (color:rgb .5 .5 .5). Substitute for .5 any number between 0 and 1 inclusive.
• command-options is optional and can be one or more of the following strings:
  • "dashed" instructs the rendering code to draw hidden lines as dashes.
  • "dotted" instructs the rendering code to draw hidden lines as dots.
  • "thinner" instructs the rendering code to draw visible lines as thicker, so that the hidden lines appear thinner.
    • If a number immediately follows, then the default thickness of 3 is overridden by that number.
  • "dimmer" instructs the rendering code to draw hidden lines as dashes.
    • If a number immediately follows, then the default brightness of 0.5 is overridden by that number.
  • "outer" instructs the rendering code to draw the outer lines thicker
    • If a number immediately follows, then the default outer line thickness of 7 is overridden by that number.

Limitations

Wire data is ignored. Bodies must not be self-intersecting.

Examples

• Scheme code that illustrates a simple model and various options for HLR rendering.
• Scheme code that illustrates a simple model and various options for HLR rendering using occurrences.

Other examples of the Scheme command (phlv5:compute):

   * (phlv5:compute)  ; Hidden lines are not displayed
   * (phlv5:compute 'dashed)  ; Hidden lines are dashed (or 'dotted)
   * (phlv5:compute 'thinner)  ; Hidden lines are thinner (visible lines are 3 pixels thick)
   * (phlv5:compute 'thinner 4) ; Hidden lines are thinner by 4 pixels
   * (phlv5:compute 'dimmer)  ; Hidden lines are dimmer (darker by 0.5 in RGB)
   * (phlv5:compute 'dimmer -.3); Hidden lines are dimmer (lighter by -0.3 in RGB)
   * (phlv5:compute (color:rgb .5 .5 .5)) ; Hidden lines are colored grey
   * (phlv5:compute 'outer 7)  ; Outer edges are thicker by 7 pixels (default is 5)
   * (phlv5:compute 'dotted 'thinner 'dimmer 0.3) ; Combination of traits