# Difference between revisions of "Extrusion Edge Cases"

(→Straight spine in -Y direction) |
m (→Example) |
||

(17 intermediate revisions by 2 users not shown) | |||

Line 1: | Line 1: | ||

− | The [http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/geometry3D.html#Extrusion Extrusion] node specification has ambiguities [http://web3d.org/pipermail/x3d-public_web3d.org/2015-June/subject.html#3434] | + | The [http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/geometry3D.html#Extrusion Extrusion] node specification has ambiguities [http://web3d.org/pipermail/x3d-public_web3d.org/2015-June/subject.html#3434]. |

− | + | ||

This wiki page supports discussion on the x3d-public mailing list regarding Extrusion specification edge cases that make consistent modeling difficult. | This wiki page supports discussion on the x3d-public mailing list regarding Extrusion specification edge cases that make consistent modeling difficult. | ||

− | == | + | TODO: Slight restructuring of content on this page, issue by issue, to show |

+ | |||

+ | * name of specific issue | ||

+ | * prose excerpt from [http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/geometry3D.html#Extrusion current X3D v3.3 specification] | ||

+ | * discussion, example scene fragment (if any), and potential change to specification | ||

+ | * corresponding prose for [https://github.com/Web3DConsortium/X3D/blob/master/ISO-IEC%2019775/ISO-IEC%2019775-1/ISO-IEC%2019775-1%20V4.0/ISO-IEC%2019775-1%20V4.0%20WD1/Part01/components/geometry3D.html draft X3D v4.0 specification] | ||

+ | |||

+ | |||

+ | == Existing X3D Specification: Extrusion == | ||

The key algorithm for the Extrusion node deals with calculation of the spine-aligned cross section plane (SCP) for every point of the spine. The algorithm boils down to determining two vectors for every spine point - Y and Z. X is then calculated by cross product of those two. | The key algorithm for the Extrusion node deals with calculation of the spine-aligned cross section plane (SCP) for every point of the spine. The algorithm boils down to determining two vectors for every spine point - Y and Z. X is then calculated by cross product of those two. | ||

Line 9: | Line 16: | ||

For SCP Y, there are the following rules, in order of appearance in the spec: | For SCP Y, there are the following rules, in order of appearance in the spec: | ||

− | + | * subtracting the next spine point from the previous one, let's call it "the angle rule" (closed spines are treated as cyclic) | |

− | + | * for the first point in an open spine, subtracting the next spine point from the current one | |

− | + | * for the last point in an open spine, subtracting the current spine point from the previous one, let's call those two together "the endpoint rules" | |

− | + | * for entirely collinear spine - using the spine direction, let's call it "the rotation rule" | |

− | + | * reuse and look-ahead within the point cluster, suggested implicitly by the "coincident points have the same SCP" line in the spec | |

For SCP Y, collinear spine segments are not a problem, the basic angle rule works for those. Null segments (AKA coincident points), however, are. | For SCP Y, collinear spine segments are not a problem, the basic angle rule works for those. Null segments (AKA coincident points), however, are. | ||

Line 19: | Line 26: | ||

For SCP Z, there are the following rules, in the same order: | For SCP Z, there are the following rules, in the same order: | ||

− | + | * cross product of the two adjacent spine segments, let's call it "the angle rule" | |

− | + | * if available, reuse of the previous Z | |

− | + | * if not, look-ahead to the first defined Z | |

− | + | * for entirely collinear splines, the Z axis of the coordinate system, rotated, AKA "the rotation rule" | |

For SCP Z calculation, both null and collinear spine segments warrant special treatment. | For SCP Z calculation, both null and collinear spine segments warrant special treatment. | ||

Line 34: | Line 41: | ||

See the example below for the effect of this rule. | See the example below for the effect of this rule. | ||

− | == Problems with the | + | == Problems with the X3D Specification == |

=== Coincident Spine Points and Y === | === Coincident Spine Points and Y === | ||

Line 42: | Line 49: | ||

==== Example ==== | ==== Example ==== | ||

− | + | Consider [http://www.jishop.com/temp/extrusion/threecoin.png the spine on the linked image]. | |

− | Let's consider the generation of the CSP Y for the middle points of this spine. | + | We have a cluster of three coincident points in the middle. Let's consider the generation of the CSP Y for the middle points of this spine. |

For point #1, the angle rule produces the vector {{overline|(01)}} (in red). | For point #1, the angle rule produces the vector {{overline|(01)}} (in red). | ||

Line 70: | Line 77: | ||

If the spine is entirely collinear (and thus doesn't allow for SCP Z calculation by the angle rule), the standard calls for generating the SCP in the following manner ("the rotation rule"): | If the spine is entirely collinear (and thus doesn't allow for SCP Z calculation by the angle rule), the standard calls for generating the SCP in the following manner ("the rotation rule"): | ||

− | + | * The direction of the spine is determined (as a unit vector) | |

− | + | * The rotation that takes the vector {{Overline|(0,1,0)}} to the said direction vector is calculated | |

− | + | * This rotation is applied to vectors {{Overline|(1,0,0)}} and {{Overline|(0,0,1)}}, and those are the X and Z axes of the SCP. | |

X3DOM implements the rotation rule in a weird way. Under X3DOM, [https://github.com/x3dom/x3dom/issues/570 an extrusion in X or Z direction looks completely flat]. | X3DOM implements the rotation rule in a weird way. Under X3DOM, [https://github.com/x3dom/x3dom/issues/570 an extrusion in X or Z direction looks completely flat]. | ||

Line 80: | Line 87: | ||

=== Straight spine in -Y direction === | === Straight spine in -Y direction === | ||

− | If the vector in the 1st step happens to be (0,-1,0), the rotation in the 2nd step is not unique. X3DOM, InstantReality, and Xj3D implement this case in different ways. Consider the following scene: | + | If the vector in the 1st step happens to be (0,-1,0), the rotation in the 2nd step is not unique. X3DOM, InstantReality, and Xj3D implement this case in different ways. Consider [http://www.jishop.com/temp/x3d/#ExtrusionDirY the following scene]: |

<code><Shape> | <code><Shape> | ||

Line 96: | Line 103: | ||

==== Public Example ==== | ==== Public Example ==== | ||

− | The Harrier model in the Savage model archive actually has extrusions in the -Y direction. Both wings of the airplane (node DEFs Left_Wing and Right_Wing) are implemented that way. Under X3DOM and Xj3D, the wings are misrendered. From the look of the model, it's obvious that the author expected the SCP to be spanned by {{Overline|(-1,0,0)}} and {{Overline|(0,0,1)}}. InstantReality displays this model as expected, at least the wings are not backwards, like they are under X3DOM. | + | [http://www.jishop.com/temp/x3d/#AV8bHarrier The Harrier model] in the Savage model archive actually has extrusions in the -Y direction. Both wings of the airplane (node DEFs Left_Wing and Right_Wing) are implemented that way. Under X3DOM and Xj3D, the wings are misrendered. From the look of the model, it's obvious that the author expected the SCP to be spanned by {{Overline|(-1,0,0)}} and {{Overline|(0,0,1)}}. InstantReality displays this model as expected, at least the wings are not backwards, like they are under X3DOM. |

+ | |||

+ | See the way it renders in [http://www.jishop.com/temp/extrusion/Harrier_X3DOM.png X3DOM], [http://www.jishop.com/temp/extrusion/Harrier_InRe.png InstantReality], [http://www.jishop.com/temp/extrusion/Harrier_Xj3D.png Xj3D]. | ||

=== Spine with ambiguous direction === | === Spine with ambiguous direction === | ||

Line 111: | Line 120: | ||

Under X3DOM, it appears entirely flat. Under InstantReality, it appears, but one frustum is visible while the other is not. Under Xj3D, it doesn't appear at all. | Under X3DOM, it appears entirely flat. Under InstantReality, it appears, but one frustum is visible while the other is not. Under Xj3D, it doesn't appear at all. | ||

− | |||

=== Floating Point Rounding === | === Floating Point Rounding === | ||

Line 119: | Line 127: | ||

Determination of point coincidence, however, is a safe operation, as long as spine coordinates were hand-written and not tool-generated. | Determination of point coincidence, however, is a safe operation, as long as spine coordinates were hand-written and not tool-generated. | ||

+ | == References and Resources == | ||

− | + | * X3D v3.3 ISO Specification [http://www.web3d.org/documents/specifications/19775-1/V3.3/Part01/components/geometry3D.html#Extrusion 13.3.5 Extrusion] | |

+ | * X3D v4.0 Draft Specification [https://github.com/Web3DConsortium/X3D/blob/master/ISO-IEC%2019775/ISO-IEC%2019775-1/ISO-IEC%2019775-1%20V4.0/ISO-IEC%2019775-1%20V4.0%20WD1/Part01/components/geometry3D.html 13.3.5 Extrusion] (access restricted to Web3D Consortium members) | ||

− | + | * Scenes of interest | |

+ | ** ExtrusionExamples.x3d | ||

+ | ** ExtrusionEdgeCases.x3d |

## Latest revision as of 09:48, 1 June 2016

The Extrusion node specification has ambiguities [1]. This wiki page supports discussion on the x3d-public mailing list regarding Extrusion specification edge cases that make consistent modeling difficult.

TODO: Slight restructuring of content on this page, issue by issue, to show

- name of specific issue
- prose excerpt from current X3D v3.3 specification
- discussion, example scene fragment (if any), and potential change to specification
- corresponding prose for draft X3D v4.0 specification

## Contents

## Existing X3D Specification: Extrusion

The key algorithm for the Extrusion node deals with calculation of the spine-aligned cross section plane (SCP) for every point of the spine. The algorithm boils down to determining two vectors for every spine point - Y and Z. X is then calculated by cross product of those two.

For SCP Y, there are the following rules, in order of appearance in the spec:

- subtracting the next spine point from the previous one, let's call it "the angle rule" (closed spines are treated as cyclic)
- for the first point in an open spine, subtracting the next spine point from the current one
- for the last point in an open spine, subtracting the current spine point from the previous one, let's call those two together "the endpoint rules"
- for entirely collinear spine - using the spine direction, let's call it "the rotation rule"
- reuse and look-ahead within the point cluster, suggested implicitly by the "coincident points have the same SCP" line in the spec

For SCP Y, collinear spine segments are not a problem, the basic angle rule works for those. Null segments (AKA coincident points), however, are.

For SCP Z, there are the following rules, in the same order:

- cross product of the two adjacent spine segments, let's call it "the angle rule"
- if available, reuse of the previous Z
- if not, look-ahead to the first defined Z
- for entirely collinear splines, the Z axis of the coordinate system, rotated, AKA "the rotation rule"

For SCP Z calculation, both null and collinear spine segments warrant special treatment.

## Proposed Amendment for the Angle/Endpoint Rules

The spec does mention the desire that the SCP Y approximate the tangent to the spine. In spirit of that, we might extend the angle/endpoint rules for both Y and Z by replacing the notions of the next/previous point with next/previous **distinct** point. With this amendment in place, the reuse/look-ahead rule for Y becomes unnecessary.

For spines with all distinct points, this rule extension will produce no difference in tesselation. As for the geometries with matching points, their treatment is wildly inconsistent under existing implementations as it is, so the harm will be minimal.

See the example below for the effect of this rule.

## Problems with the X3D Specification

### Coincident Spine Points and Y

Coincident spine points are allowed under the spec. For those, the rules for generating Y are in conflict. The difference of the adjacent spine points might not be a null vector; the angle rule and the reuse/look-ahead rule might provide different results (see the example below, point #3). The standard doesn't specify which rule takes precedence. If the reuse rule is only supposed to kick in if the subtraction rule returns a null vector, the standard might as well say so.

#### Example

Consider the spine on the linked image.

We have a cluster of three coincident points in the middle. Let's consider the generation of the CSP Y for the middle points of this spine.

For point #1, the angle rule produces the vector (01) (in red).

For point #2, the angle rule produces a null Y. The reuse rule suggests the vector (01) (in red). The proposed extended angle rule, on the other hand, would produce Y as the vector (04) (in green).

For point #3, the angle rule would produce (34) (in yellow), but the reuse rule would produce (01) (red). This is a case of two rules producing valid but different results. That's why some kind of clarification of rule precedence in the spec would be necessary. The same unresolved contradiction in rules would arise even in case of two conincident points in the middle of a spine.

The extended angle rule would still produce (04) (green) for point # 3.

It's worth noting that for a spine like this, **none** of the existing rules for Z would produce a nonnull SCP Z for any of the points. The extended angle rule, however, would; the Z would be produced as (10)×(34)

A similar example can be drawn up for an open spine with two conincident spine points in the beginning or in the end.

The following geometry implements the example:

`<Extrusion spine="-5 0 0 0 0 0 4 4 0 4 4 0 4 4 0 8 0 0" crossSection="-1 0 0 1 1 0 -1 0" scale="1 1 1 1 1 1 2 2 3 3 3 3"/>`

The first spine point at (-5,0,0) was added to give it a valid SCP Z.

X3DOM, Xj3D and InstantReality all produce different shapes for such a geometry.

### Rules for Collinear Spines

If the spine is entirely collinear (and thus doesn't allow for SCP Z calculation by the angle rule), the standard calls for generating the SCP in the following manner ("the rotation rule"):

- The direction of the spine is determined (as a unit vector)
- The rotation that takes the vector (0,1,0) to the said direction vector is calculated
- This rotation is applied to vectors (1,0,0) and (0,0,1), and those are the X and Z axes of the SCP.

X3DOM implements the rotation rule in a weird way. Under X3DOM, an extrusion in X or Z direction looks completely flat.

Discounting that, there are still some problems with the rule.

### Straight spine in -Y direction

If the vector in the 1st step happens to be (0,-1,0), the rotation in the 2nd step is not unique. X3DOM, InstantReality, and Xj3D implement this case in different ways. Consider the following scene:

```
<Shape>
<Appearance><Material diffuseColor="0 0.5 0.5"/></Appearance>
<Extrusion spine="0 0 0 0 1 0" solid="false" crossSection="-1 0 0 2 1 0 -1 0"/>
</Shape>
```

```
<Shape>
<Appearance><Material diffuseColor="0 0.5 0.5"/></Appearance>
<Extrusion spine="3 1 0 3 0 0" solid="false" crossSection="-1 0 0 2 1 0 -1 0"/>
</Shape>
```

It looks one way under X3DOM and InstantReality, another way under Xj3D.

#### Public Example

The Harrier model in the Savage model archive actually has extrusions in the -Y direction. Both wings of the airplane (node DEFs Left_Wing and Right_Wing) are implemented that way. Under X3DOM and Xj3D, the wings are misrendered. From the look of the model, it's obvious that the author expected the SCP to be spanned by (-1,0,0) and (0,0,1). InstantReality displays this model as expected, at least the wings are not backwards, like they are under X3DOM.

See the way it renders in X3DOM, InstantReality, Xj3D.

### Spine with ambiguous direction

The spec doesn't specify what constitutes the "spine direction". It refers to to "the vector formed by the spine points", but depending on the choice of points, it might be a different vector (up to the sign), or even a null one. Common sense suggests using a nonnull spine segment, but the spec doesn't say so. And it seems like the implementors use, instead, the first and the last point of the spine, which is simpler, but open to errors. If the spine goes: (0,0,0) - (0,1,0) - (0,0,0), it's collinear, but what is its direction?

#### Example

Consider the following geometry:

`<Extrusion spine="0 0 0 0 1 0 0 0 0" solid="false" scale="1 1 1.2 1.2 1.4 1.4" beginCap="false" endCap="false"/>`

It's supposed to represent two square frusta, where the bottom base of the smaller one is glued to the top base of the larger one.

Under X3DOM, it appears entirely flat. Under InstantReality, it appears, but one frustum is visible while the other is not. Under Xj3D, it doesn't appear at all.

### Floating Point Rounding

The spec calls for conditionals based upon floating point arithmetic results, specifically, the determination of collinearity. Floating point calculations being inherently imprecise, this is a huge can of worms. Details to follow.

Determination of point coincidence, however, is a safe operation, as long as spine coordinates were hand-written and not tool-generated.

## References and Resources

- X3D v3.3 ISO Specification 13.3.5 Extrusion

- X3D v4.0 Draft Specification 13.3.5 Extrusion (access restricted to Web3D Consortium members)

- Scenes of interest
- ExtrusionExamples.x3d
- ExtrusionEdgeCases.x3d