 |
System Attribute Definitions |
|
Contents
Note: Some user-defined attribute definitions could have a similar naming convention to a system attribute definition. If not documented in this chapter, an attribute definition should be treated as user-defined.
|
[back to top]
A.1 System attribute definitions whose field values define a property
A.1.1 Colour
|
Identifier
|
SDL/TYSA_COLOUR
|
|
Type id
|
8001
|
|
Legal Owner (entity types)
|
face
edge
|
|
Fields
|
real
|
Red value
|
These three values should be in the range 0.0 to 1.0
|
|
|
Green value
|
|
|
Blue value
|
A.1.2 Colour 2
|
Identifier
|
SDL/TYSA_COLOUR_2
|
|
Type id
|
8040
|
|
Legal Owners
|
body, instance, assembly
|
|
Fields
|
real
|
Red value
|
These three values should be in the range of 0.0 to 1.0
|
|
Green value
|
|
Blue value
|
A.1.3 Density attributes
There are density attributes for each of regions, faces, edges and vertices in addition to the system attribute for density of a body.
The region/face/edge/vertex attributes will be taken into account when finding the mass, centre of gravity and moment of inertia of a body or of the entity to which the attribute is attached:
-
The mass of a region will not include that of any of its faces or edges, and the same applies to faces and edges and their boundaries.
-
A void region will always have zero mass whatever its density and a solid region will inherit its density from the body if it does not have a density of its own.
-
The default density for faces, edges and vertices is always zero.
A.1.3.1 Density (of a body)
|
Identifier
|
SDL/TYSA_DENSITY
|
|
Type_id
|
8004
|
|
Legal Owner (entity types)
|
body
|
|
Fields
|
real
|
Density
|
|
string
|
Units
|
A body without a density attribute is taken to have, by default, a density of 1.0.
The character field “units” is optional.
A.1.3.2 Region density
|
Identifier
|
SDL/TYSA_REGION_DENSITY
|
|
Type_id
|
8023
|
|
Legal Owner (entity types)
|
region
|
|
Fields
|
real
|
Density of region
|
|
string
|
Units
|
This attribute only makes sense for solid regions; void regions always have a mass of zero.
A solid region without a density attribute is taken to have, by default, the same density as its owning body.
The character field “units” is optional.
A.1.3.3 Face density
|
Identifier
|
SDL/TYSA_FACE_DENSITY
|
|
Type_id
|
8024
|
|
Legal Owner (entity types)
|
face
|
|
Fields
|
real
|
Density of face
|
|
string
|
Units
|
The value of this attribute is treated as a mass per unit area.
A mass will be calculated for a face only when a face possesses this attribute. In all other cases the mass of a face is not defined.
The character field “units” is optional.
A.1.3.4 Edge density
|
Identifier
|
SDL/TYSA_EDGE_DENSITY
|
|
Type_id
|
8025
|
|
Legal Owner (entity types)
|
edge
|
|
Fields
|
real
|
Density of edge
|
|
string
|
Units
|
The value of this attribute is treated as a mass per unit length.
A mass will be calculated for an edge only when an edge possesses this attribute. In all other cases the mass of an edge is not defined.
The character field “units” is optional.
A.1.3.5 Vertex density
|
Identifier
|
SDL/TYSA_VERTEX_DENSITY
|
|
Type_id
|
8026
|
|
Legal Owner (entity types)
|
vertex
|
|
Fields
|
real
|
Mass of vertex
|
|
string
|
Units
|
The value of this attribute is treated as a point mass.
A mass will be calculated for a vertex only when a vertex possesses this attribute. In all other cases the mass of a vertex is not defined.
The character field “units” is optional.
A.1.4 Group control
|
Identifier
|
SDL/TYSA_GROUP_CONTROL
|
|
Type id
|
8039
|
|
Legal Owner (entity types)
|
group
|
|
Fields
|
integer
|
Two integers, containing numerical tokens from PK_GROUP_split_empty_t and PK_GROUP_merge_empty_t, in that order.
|
PK_GROUP_split_empty_t can take one of the following numerical tokens:
|
Token
|
Description
|
|
24780
|
The group remains in the original part. (Default)
|
|
24781
|
The group remains in the original part, and a copy is made in the split-off part.
|
PK_GROUP_merge_empty_t can take one of the following numerical tokens:
|
Token
|
Description
|
|
24790
|
The empty groups in both parts appear in the merged part. (Default)
|
|
24791
|
Pairs of identical empty groups, one in each part, are merged into one group in the merged part. "Identical" here means having the same attributes (including SDL/TYSA_GROUP_CONTROL attributes). Identical empty groups in the same part are not merged.
|
A.1.5 Hatching
|
Identifier
|
SDL/TYSA_HATCHING
|
|
Type_id
|
8003
|
|
Legal Owner (entity types)
|
face
|
|
Fields
|
real
|
real 1
|
|
real 2
|
|
real 3
|
|
real 4
|
|
integer
|
Hatching type
|
For planar hatching (Hatching type is 3) - the four real values define the hatch orientation as a vector and a spacing between consecutive planes.
For radial hatching (Hatching type is 2) - the first three real values define the spacing of the hatch lines. The fourth value is not used.
For parametric hatching (Hatching type is 22) - the first two real values define the spacing in u and v respectively. The last two values are not used.
A.1.5.1 Planar hatch
|
Identifier
|
SDL/TYSA_PLANAR_HATCH
|
|
Type_id
|
8021
|
|
Legal Owner (entity types)
|
face
|
|
Fields
|
real
|
x component
|
‘direction’ or plane normal
|
|
y component
|
|
z component
|
|
‘pitch’ or separation
|
|
x component
|
position vector
|
|
y component
|
|
z component
|
For
planar hatching, an attribute with this definition takes precedence over an attribute with the
SDL/TYSA_HATCHING
definition, if a face has both types of attribute attached.
A.1.5.2 Radial hatch
|
Identifier
|
SDL/TYSA_RADIAL_HATCH
|
|
Type_id
|
8027
|
|
Legal Owner (entity types)
|
face
|
|
Fields
|
real
|
radial around
|
|
|
|
radial along
|
|
|
|
radial about
|
|
|
|
radial around start
|
|
|
|
radial along start
|
|
|
|
radial about start
|
For
radial hatching, an attribute with this definition takes precedence over an attribute with the
SDL/TYSA_HATCHING
definition, if a face has both types of attribute attached.
A.1.5.3 Parametric hatch
|
Identifier
|
SDL/TYSA_PARAM_HATCH
|
|
Type_id
|
8028
|
|
Legal Owner (entity types)
|
face
|
|
Fields
|
real
|
u spacing
|
|
|
v spacing
|
|
|
u start
|
|
|
v start
|
For
parametric hatching, an attribute with this definition takes precedence over an attribute with the
SDL/TYSA_HATCHING
definition, if a face has both types of attribute attached.
A.1.5.4 Parametric hatch (numeric control)
|
Identifier
|
SDL/TYSA_PARAM_NUM_HATCH
|
|
Type_id
|
8049
|
|
Legal Owner (entity types)
|
face
|
|
Fields
|
integer
|
number of u hatch lines
|
|
|
number of v hatch lines
|
|
|
|
|
|
|
For
parametric hatching (numeric control), an attribute with this definition takes precedence over an attribute with the
SDL/TYSA_HATCHING
definition or the
SDL/TYSA_PARAM_HATCH
definition, if a face has both types of attribute attached.
A.1.6 Layer
|
Identifier
|
SDL/TYSA_LAYER
|
|
Type id
|
8042
|
|
Legal Owner (entity types)
|
body, instance, assembly
|
|
Fields
|
ustring
|
Layer number
|
|
ustring
|
Layer name/label
|
|
ustring
|
Extra user data
|
|
integer
|
Visibility information. 0=visible, 1=invisible. Other values not allowed.
|
A.1.7 Name
|
Identifier
|
SDL/TYSA_NAME
|
|
Type_id
|
8017
|
|
Legal Owner (entity types)
|
assembly, body, instance, shell, face, loop, edge, vertex, group, surface, curve, point
|
|
Fields
|
string
|
Name of entity
|
A.1.8 Reflectivity
|
Identifier
|
SDL/TYSA_REFLECTIVITY
|
|
Type_id
|
8014
|
|
Legal Owner (entity types)
|
face
|
|
Fields
|
real
|
Coefficient of specular reflection
|
|
|
Proportion of coloured light in highlights
|
|
|
Coefficient of diffuse reflection
|
|
|
Coefficient of ambient reflection
|
|
|
integer
|
Reflection power
|
A.1.9 Translucency
|
Identifier
|
SDL/TYSA_TRANSLUCENCY
|
|
Type_id
|
8015
|
|
Legal Owner (entity types)
|
face
|
|
Fields
|
real
|
Transparency coefficient
|
range 0.0 to 1.0, where 0 is opaque and 1 is transparent
|
A.1.10 Translucency 2
|
Identifier
|
SDL/TYSA_TRANSLUCENCY_2
|
|
Type id
|
8041
|
|
Legal Owner (entity types)
|
body, instance, assembly
|
|
Fields
|
real
|
Transparency coefficient
|
range 0.0 to 1.0, where 0 is opaque and 1 is transparent
|
A.1.11 Transparency
|
Identifier
|
SDL/TYSA_TRANSPARENCY
|
|
Type_id
|
8029
|
|
Legal Owner (entity types)
|
body, face
|
|
Fields
|
integer
|
Non-zero transparency coefficient value is transparent
|
A body may be rendered transparent if it has an attached transparency attribute with a non-zero transparency coefficient.
A.1.12 Unicode name
|
Identifier
|
SDL/TYSA_UNAME
|
|
Type_id
|
8038
|
|
Legal Owner (entity types)
|
assembly, body, instance, shell, face, loop, edge, vertex, group, surf, curve, point, region
|
|
Fields
|
ustring
|
Name of entity
|
A.1.13 Scale factor
|
Identifier
|
SDL/TYSA_SCALE_FACTOR
|
|
|
Type_id
|
8051
|
|
|
Legal Owner (entity types)
|
Assembly, body
|
|
|
Fields
|
integer
|
An integer representing the scale factor of the part. It must be in the range [-6, 3].
|
This attribute definition represents the scale factor of a part.
Note: For data interoperability purposes, we recommend applications interpret 0 as indicating a mapping 1 XT unit = 1 metre.
|
[back to top]
A.2 System attribute definitions whose presence alone defines a property
A.2.1 Group merge behaviour
|
Identifier
|
SDL/TYSA_GROUP_MERGE
|
|
Type_id
|
8037
|
|
Legal Owner (entity types)
|
group
|
|
Fields
|
string
|
Unused
|
If a group has an attribute of this definition attached, and an entity in the group is merged with an entity not in that group, one occurrence of the resulting merged entity is added to each group that contained all of the original entities.
A.2.2 Invisibility
|
Identifier
|
SDL/TYSA_INVISIBLE
|
|
Type id
|
8043
|
|
Legal Owners
|
body, assembly, instance
|
|
Fields
|
none
|
A.2.3 Non-mergeable edges
|
Identifier
|
SDL/TYSA_EDGE_NO_MERGE
|
|
Type_id
|
8032
|
|
Legal Owner (entity types)
|
edge
|
|
Fields
|
string
|
Unused
|
If an edge has an attribute of this definition attached, it indicates that the edge should not be merged in any modelling operations.
A.2.4 Region
|
Identifier
|
SDL/TYSA_REGION
|
|
Type_id
|
8013
|
|
Legal Owner (entity types)
|
face
|
|
Fields
|
string
|
Unused
|
Regional data will allow the user to analyse a hidden-line picture for distinct regions in the 2D view.
[back to top]