KID Class Structure   

<<< Fault Reporting in KID Chapters Parasolid LISP Functions >>>

Contents

[back to top]


A.1 Introduction

This appendix gives the class tree of KID, and the functions which are available for each class. The functions are described in detail elsewhere. The names of all KID classes are reserved words within KID and should not be overwritten.

[back to top]

A.1.1 Modeller substructure

The class structure for KID, along with the class functions, appears on the following pages. The notation to be adopted is highest order class to the extreme left of the page, class property functions to the extreme right. Modeller is the root class of the tree shown.

 

Class

Function

Description

modeller

start

start modeller

 

stop

stop modeller

 

replicate

copy properties and item

 

rename

rename object

 

delete

undefine object, delete item if one

 

enquire

user help on objects

 

resabs

returns linear model resolution

 

resang

returns angular model resolution

 

mark

sets rollback mark

 

roll

rolls back kernel to last mark set

 

roll_class

rolling back live KID objects

option

bb

bulletin board use

 

bb_user

user fields bulletin option

 

bspline_io

switches output parametrisations from bezier to bspline

 

bspline_geometry

sets B-curve/surface modeling to composite geometry

 

check

local checking switch

 

continuity_checking

continuity checking

 

data_checking

consistency checks for ATTGEO

 

enquire

information on option settings

 

journal

file for kernel output

 

logging

enables rollback

 

parameter_checking

parameter checking

 

self_checking

self intersection checking

 

get_snapshot

binary/text reception of a snapshot

 

save_snapshot

binary/text saving of a snapshot

 

reset

sets all options to STAMOD defaults

 

receive

binary/text reception

 

transmit

binary/text transmission

 

timing

controls timing information

 

user_field

set user field length

 

logging

set logging type

 

logging_number

set rollmark limit

 

logging_forward

set forward logging

 

raise errors

raise LISP error for Parasolid failures reported through tokens

entity

(see section entity sub-structure)

primitive

(see section primitive sub-structure)

xgraphics

(see section xgraphics sub-structure)

[back to top]

A.1.2 Entity substructure

The entity sub-structure contains all the topological and geometric attributes which are used in the solid modeller. It contains everything from a single point to an assembly. Functions to modify or remove many of the features are also included in the entity sub-structure.

 

Class

Function

Description

entity

 

 

 

pick

picks items from screen

 

 

 

 

pick_from

picks connected kernel entities

 

 

 

 

pick_using

logical pick

 

 

 

 

pick_node

uses node id to pick entity

 

 

 

 

include

add entities to object

 

 

 

 

remove

remove entities from object

 

transformable

 

 

move

translate transformable items

 

 

 

 

rotate

rotate transformable items

 

 

transformation

 

apply

applies transformation to entity

 

 

topology

 

sweep

sweep item to create new item

 

 

 

 

swing

swing item to create new item

 

 

 

 

clash

coordinate/topology clash test

 

 

 

 

sketch

add sketch of items to selected view

 

 

 

 

box

box (return box vector) item

 

 

 

 

faces

faces of entity

 

 

 

 

edges

edges of entity

 

 

 

 

vertices

vertices of entity

 

 

 

 

hidden

hidden line entity

 

 

 

 

facet

facet entity

 

 

 

 

shade

shade entity

 

 

 

 

silhouette

silhouette entity

 

 

 

 

fillet

fillet all edges with given radius

 

 

 

 

chamfer

chamfer all edges with given radius

 

 

 

 

imprint

imprint tool on entity

 

 

 

 

min_distance

closest approach to point or entity

 

 

instance

 

 

 

 

 

part

 

transmit

transmit part to file

 

 

 

 

receive

receive part from file

 

 

 

 

state

part state

 

 

 

 

key

key of loaded part

 

 

 

 

remove_key

clear key from loaded part

 

 

 

 

mass

compute mass of part

 

 

 

 

identify

look up tag of named part

 

 

 

 

assemble

creates assembly from parts

 

 

 

assembly

disassemble

break down into bodies

 

 

 

 

bodies

list first level bodies

 

 

 

 

instances

list first level instances

 

 

 

 

transforms

list first level transforms

 

 

 

 

level

flattens assembly

 

 

 

body

check

consistency check

 

 

 

 

intersect

intersection of target/tool bodies

 

 

 

 

merge

remove redundant edges vertices faces

 

 

 

 

section

section body with surface

 

 

 

 

subtract

subtract tool from target body

 

 

 

 

unite

unite tool with target body

 

 

 

 

blend_fix

fix unfixed blends in body

 

 

 

 

regions

regions of body

 

 

 

 

volume

volume of body

 

 

 

 

cofg

centre of gravity of body

 

 

 

 

area

surface area of body

 

 

 

 

halve

section through cofg along axis

 

 

 

 

quarter

two sections

 

 

 

 

reflect

reflect body in planar surface

 

 

 

 

mirror

unite with mirror image

 

 

 

 

magnify

scale body by factor

 

 

 

 

offset

offset body distance

 

 

 

 

hollow

hollow to given thickness

 

 

 

 

sew

sew a collection of sheet bodies

 

 

multiply

shell

 

 

 

 

 

feature

 

 

 

 

 

loo

 

loop (loop is LISP reserved word)

 

 

single

 

merge

remove redundant faces,edges and vertices

 

 

 

 

unfix

detach geometry from faces, edges or vertices

 

 

 

region

 

 

 

 

 

vertex

fillet

blend at vertices with given radii

 

 

 

face

check

consistency check

 

 

 

 

delete_faces

delete face from body

 

 

 

 

create_solid

create new body with copied faces

 

 

 

 

create_sheet

create new sheet body from face

 

 

 

 

remove_faces

remove face(s) and create new body

 

 

 

 

move

move face(s)

 

 

 

 

rotate

rotate face(s)

 

 

 

 

taper

draft planar, cylindrical, conical face(s)

 

 

 

 

tweak

modify face surface to given surface

 

 

 

 

ntweak

modify face surface to reversed surface

 

 

 

 

twefac

modify faces by given transforms

 

 

 

 

fix

fit a surface to a face

 

 

 

 

hatch_enq

enquire hatching attribute

 

 

 

 

planar_hatch

get/set planar hatching

 

 

 

 

radial_hatch

get/set radial hatching

 

 

 

 

para_hatch

get/set parametric hatch

 

 

 

 

cofg

centre of gravity of face

 

 

 

 

area

surface area of face

 

 

 

edge

blend_check

check blends

 

 

 

 

blend_enquire

blend information

 

 

 

 

blend_remove

remove unfixed blends

 

 

 

 

pick_blends

picks edges with unfixed blends

 

 

 

 

length

arc length of edge

 

 

geometry

 

check

consistency check

 

 

 

 

make_body

create body from geometry

 

 

 

 

part

part to which geometry is attached

 

 

 

surface

intersect

intersects with supplied surface

 

 

 

 

parameterise

parameters at position

 

 

 

 

deparameterise

position at parameters

 

 

 

 

faces

faces to which surface is attached

 

 

 

 

uvbox

surface parameter uvbox

 

 

 

 

nabx

non-aligned box

 

 

 

curve

parameterise

parameter at position

 

 

 

 

deparameterise

position at parameter

 

 

 

 

march

list of points on the curve

 

 

 

 

edges

edges to which curve is attached

 

 

 

 

fin

fin to which curve is attached

 

 

 

 

interval

curve parameter interval

 

 

 

 

nabx

non-aligned box

 

 

 

point

vertex

vertex to which point is attached

 

 

associated

attribute

system_attribute

name

 

 

 

 

 

blend_v5

 

 

 

 

 

translucency

 

 

 

 

 

reflectivity

 

 

 

 

 

phull

 

 

 

 

 

plines

 

 

 

 

 

density

 

 

 

 

 

hatching

 

 

 

 

 

blend

 

 

 

 

 

colour

[back to top]

A.1.3 Primitive substructure

The primitive sub-structure contains all the functions which are required to create anything in KID, from single points, surfaces, solid objects, through to assemblies.

The create functions create primitive solids, curves, surfaces, assemblies and instances.

 

Class

Function

Description

primitive

 

 

 

 

 

 

 

 

p_transformable

 

 

 

 

 

 

 

p_geometry

 

p_vector

 

 

 

 

 

 

p_surface

p_offset

 

 

create

 

 

 

 

p_spun

 

 

create

 

 

 

 

p_swept

 

 

create

 

 

 

 

p_toroidal

 

 

create

 

 

 

 

p_spherical

 

 

create

 

 

 

 

p_planar

 

 

create

 

 

 

 

p_cylindrical

 

 

create

 

 

 

 

p_conical

 

 

create

 

 

 

p_unbounded_curve

p_line

 

 

create

 

 

 

 

p_ellipse

 

 

create

 

 

 

 

p_circle

 

 

create

 

 

 

 

p_intersection

 

 

create

 

 

 

 

p_points

 

 

pick

picks point sequence
in image plane

 

 

 

p_point

 

 

 

 

 

 

 

p_bounded_curve

 

 

scribe

inscribes bounded
curve on face

 

 

p_transformation

p_general_transformation

 

 

create

 

 

 

 

p_translation

 

 

create

 

 

 

 

p_rotation

 

 

create

 

 

 

 

p_reflection

 

 

create

 

 

 

 

p_equal_scaling

 

 

create

 

 

 

p_topology

p_body

p_sheet

 

create

 

 

 

 

 

p_wire

 

create

 

 

 

 

 

p_profile

 

create

 

 

 

 

 

p_parasurf

 

create

 

 

 

 

 

p_paracurve

 

create

 

 

 

 

 

p_pyramid

 

create

 

 

 

 

 

p_cylinder

 

create

 

 

 

 

 

p_sphere

 

create

 

 

 

 

 

p_torus

 

create

 

 

 

 

 

p_prism

 

create

 

 

 

 

 

p_cone

 

create

 

 

 

 

 

p_block

 

create

 

 

 

 

 

p_acorn

 

create

 

 

 

 

p_instance

 

 

create

 

 

 

 

p_assembly

 

 

create

 

 

 

 

p_feature

 

 

 

 

 

p_associated

p_attribute

p_system_attribute

p_blend

 

apply

apply blend to edge

 

 

 

 

 

 

extract

extracts blend info
from edge

 

 

 

 

 

p_fillet

 

 

 

 

 

 

 

p_chamfer

 

 

[back to top]

A.1.4 Graphics substructure

The class graphics is a subclass of xgraphics, so that if default values are changed in graphics they can be retrieved from xgraphics.

 

Class

Function

Description

xgraphics

autowindow

set window to minimum

 

clear

clear current view

 

invisible

switch for hidden lines

 

redraw

redraw current view

 

ar

autowindow and redraw

 

axes

draw axes

 

frame

draw frame

 

enquire

graphics properties information

 

select

select a view

 

sketch

sketch all items in drawing list

 

blend

draw unfixed blends

 

hidden

hidden line view

 

silhouette

draw silhouette curves

 

smooth

blanks smooth edges

 

planar_hatch

planar hatching

 

radial_hatch

radial hatching

 

para_hatch

parametric surface hatching

 

perspective

perspective view

 

zoom

magnify by factor

 

pan_down

view manipulation functions

 

pan_up

 

 

pan_left

 

 

pan_right

 

 

view_direction

view direction

 

view_from

eye point

 

view_to

view point

 

view_vertical

define vector as vertical in view

 

view_window_xmax

functions to manipulate image extremes

 

view_window_ymax

 

 

view_window_xmin

 

 

view_window_ymin

 

 

pick_window

 

 

pick_centre

 

graphics

 

 

 

[back to top]

<<< Fault Reporting in KID Chapters Parasolid LISP Functions >>>