Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

1.0 Organization and formatting updates #308

Merged
merged 36 commits into from
Jun 7, 2018
Merged

1.0 Organization and formatting updates #308

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
36 commits
Select commit Hold shift + click to select a range
051e78d
Reorg and formatting changes, add licence
ggetz May 11, 2018
5fdbc93
Future plans
ggetz May 11, 2018
cf8dad2
Fix TOC
ggetz May 11, 2018
579502a
Reorg fixes
ggetz May 13, 2018
31145d8
Add property reference
ggetz May 13, 2018
7686e4a
Add styling property reference
ggetz May 14, 2018
0bc4052
Fomratting, properties
ggetz May 14, 2018
58bc518
Property reference
ggetz May 30, 2018
7b0e7b2
Formatting fixes
ggetz May 31, 2018
772e361
Merge branch '1.0' into 1.0-formatting
ggetz May 31, 2018
37689e6
Formatting fixes
ggetz May 31, 2018
b0f1093
Add talks
ggetz May 31, 2018
cacf1c3
Q and E edits
lilleyse May 31, 2018
9c7ae49
Tweak overview
lilleyse May 31, 2018
52b4f6f
Tweak example
lilleyse May 31, 2018
84ae79d
Move reference sections
ggetz May 31, 2018
21c1a83
Schema indentation fix
lilleyse May 31, 2018
34532f7
schema fixes
ggetz Jun 1, 2018
0f403a7
Add OGC specification document
ggetz Jun 4, 2018
3b357e7
Add Carl Reed and Scott Simmons to Acknowledgements
pjcozzi Jun 4, 2018
3770def
Fix batchTable schema reference
ggetz Jun 4, 2018
d64d31d
Update pdf
ggetz Jun 4, 2018
4cdee18
Fix pdf TOC
ggetz Jun 4, 2018
5fffd6f
Fix styling property reference
ggetz Jun 4, 2018
7866bac
Upadte TileFormat schema references
ggetz Jun 4, 2018
cd00b15
Update spatial data structures, update copyright
ggetz Jun 4, 2018
c65c3b2
Updated tileset ref doc
ggetz Jun 4, 2018
3e8f839
Small edits to spatial data structures section
lilleyse Jun 4, 2018
fc8e5d1
Update intro
ggetz Jun 5, 2018
39187a9
Update links
ggetz Jun 5, 2018
c080472
Fix styling property reference
ggetz Jun 5, 2018
b9a6d03
Update specification pdf
ggetz Jun 5, 2018
22565e7
Clarify padding some more
lilleyse Jun 6, 2018
64cd5ed
Tweak example wording for clarity
ggetz Jun 6, 2018
49bf1c2
Wording tweak
ggetz Jun 6, 2018
b122329
Update pdf
ggetz Jun 6, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 8 additions & 28 deletions specification/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -724,14 +724,15 @@ The following example colors features with a temperature above 90 as red and the
For complete details, see the [Declarative Styling](./Styling/) specification.

## Property reference

The full tileset JSON schema is defined in [`tileset.schema.json`](./schema/tileset.schema.json).

* [`Tileset`](#reference-tileset)
* [`Asset`](#reference-asset)
* [`Properties`](#reference-properties)
* [`Tile`](#reference-tile)
* [`Bounding Volume`](#reference-bounding-volume)
* [`Tile Content`](#reference-tile-content)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These links aren't working.

* [`Extension`](#reference-extension)
* [`Extras`](#reference-extras)


---------------------------------------
Expand Down Expand Up @@ -811,7 +812,7 @@ Names of 3D Tiles extensions required to properly load this tileset.
* **Required**: No

---------------------------------------
<a name="reference-asset"></a>

#### Asset

Metadata about the entire tileset.
Expand Down Expand Up @@ -859,7 +860,7 @@ Application-specific data.
* **Required**: No

---------------------------------------
<a name="reference-properties"></a>

#### Properties

A dictionary object of metadata about per-feature properties.
Expand Down Expand Up @@ -908,7 +909,7 @@ Application-specific data.


---------------------------------------
<a name="reference-tile"></a>

#### Tile

A tile in a 3D Tiles tileset.
Expand Down Expand Up @@ -997,7 +998,7 @@ An array of objects that define child tiles. Each child tile content is fully en


---------------------------------------
<a name="reference-bounding-volume"></a>

#### Bounding Volume

A bounding volume that encloses a tile or its content. Exactly one property is required.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The Exactly one property is required sentence should be changed to say exactly one of box, region, or sphere is required, since we don't want to exclude extensions/extras

Expand Down Expand Up @@ -1053,7 +1054,7 @@ Application-specific data.
* **Required**: No

---------------------------------------
<a name="reference-tile-content"></a>

#### Tile Content

Metadata about the tile's content and a link to the content.
Expand Down Expand Up @@ -1100,27 +1101,6 @@ Application-specific data.
* **Type**: `any`
* **Required**: No

---------------------------------------
<a name="reference-extension"></a>
#### Extension

Dictionary object with extension-specific objects.

Additional properties are allowed.

* **JSON schema**: [extension.schema.json](schema/extension.schema.json)


---------------------------------------
<a name="reference-extras"></a>
#### Extras

Application-specific data.

---

See the full [JSON schema](./schema).

## License

Copyright 2016 - 2018 Cesium
Expand Down
168 changes: 84 additions & 84 deletions specification/Styling/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ The following example assigns a color based on building height.
}
```

![](figures/example.png)
![](./figures/example.png)

## Concepts

Expand Down Expand Up @@ -210,45 +210,41 @@ A meta property expression can evaluate to any type. For example:

## Property reference

* [`condition`](#reference-condition)
* [`conditions`](#reference-conditions)
* [`expression`](#reference-expression)
* [`number expression`](#reference-number-expression)
* [`Point Cloud Style`](#reference-point-cloud-style) (root object)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What does (root object) mean?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I missed removing that. wetzel adds that to the schema object the command was run on.

* [`style`](#reference-style)
* [`boolean expression`](#reference-boolean-expression)
* [`color expression`](#reference-color-expression)
* [`number expression`](#reference-number-expression)
* [`conditions`](#reference-conditions)
* [`condition`](#reference-condition)
* [`definesProperty`](#reference-definesproperty)
* [`meta`](#reference-meta)
* [`metaProperty`](#reference-metaproperty)
* [`style`](#reference-style)
* [`Point Cloud Style`](#reference-point-cloud-style)


---------------------------------------
<a name="reference-expression"></a>
#### expression

A valid 3D Tiles style expression.
* [`definesProperty`](#reference-definesproperty)
* [`meta`](#reference-meta)
* [`metaProperty`](#reference-metaproperty)


---------------------------------------
<a name="reference-boolean-expression"></a>
#### boolean expression

A boolean or string with a 3D Tiles style expression that evaluates to a boolean.
A boolean or string with a 3D Tiles style expression that evaluates to a boolean. See [Expressions](specification/Styling/README.md#expressions).



---------------------------------------
<a name="reference-color-expression"></a>
#### color expression

3D Tiles style expression that evaluates to a Color.
3D Tiles style [`expression`](#reference-expression) that evaluates to a Color. See [Expressions](specification/Styling/README.md#expressions).



---------------------------------------
<a name="reference-number-expression"></a>
#### number expression
<a name="reference-condition"></a>
#### condition

An [`expression`](#reference-expression) evaluated as the result of a condition being true. An array of two expressions. If the first expression is evaluated and the result is `true`, then the second expression is evaluated and returned as the result of the condition.

3D Tiles style expression that evaluates to a number.


---------------------------------------
Expand All @@ -265,7 +261,7 @@ A series of conditions evaluated in order, like a series of if...else statements

Additional properties are not allowed.

* **JSON schema**: [style.conditions.schema.json](schema/style.conditions.schema.json)
* **JSON schema**: [style.conditions.schema.json](../../schema/style.conditions.schema.json)

##### conditions.conditions

Expand All @@ -275,31 +271,33 @@ A series of boolean conditions evaluated in order. For the first one that evalu
* **Required**: No




---------------------------------------
<a name="reference-condition"></a>
#### condition
<a name="reference-definesproperty"></a>
#### definesProperty

An expression evaluated as the result of a condition being true. An array of two expressions. If the first expression is evaluated and the result is `true`, then the second expression is evaluated and returned as the result of the condition.
An [`expression`](#reference-expression) to be evaluated for the value of that property.



---------------------------------------
<a name="reference-definesproperty"></a>
#### definesProperty
<a name="reference-expression"></a>
#### expression

A property name and the expression to be evaluated for the value of that property.
A valid 3D Tiles style expression. See [Expressions](specification/Styling/README.md#expressions).



---------------------------------------
<a name="reference-meta"></a>
#### meta

A series of property names and the expression to evaluate for the value of each property.
A series of property names and the `meta property` expression to evaluate for the value of each property.

Additional properties are allowed.

* **JSON schema**: [style.meta.schema.json](schema/style.meta.schema.json)
* **JSON schema**: [style.meta.schema.json](../../schema/style.meta.schema.json)



Expand All @@ -308,126 +306,128 @@ Additional properties are allowed.
<a name="reference-metaproperty"></a>
#### metaProperty

A property name and the expression to be evaluated for the value of that property.
The [`expression`](#reference-expression) to be evaluated for the value of that property.



---------------------------------------
<a name="reference-style"></a>
#### style
<a name="reference-number-expression"></a>
#### number expression

A 3D Tiles style.
3D Tiles style expression that evaluates to a number. See [Expressions](specification/Styling/README.md#expressions).



---------------------------------------
<a name="reference-point-cloud-style"></a>
#### Point Cloud Style

A 3D Tiles style with additional properties for Point Clouds.

**Properties**

| |Type|Description|Required|
|---|----|-----------|--------|
|**defines**|`object`|Additional expressions that may be referenced throughout the style. If a variable references a define, it gets the result of the define's evaluated expression.|No|
|**show**|`boolean,string`|Determines if a feature should be shown.|No, default: `true`|
|**color**|`string`|Determines the color blended with the feature's intrinsic color.|No, default: `"Color('#FFFFFF')"`|
|**meta**|`object`|Determines the values of non-visual properties of the feature.|No|
|**defines**|`object`|A dictionary object of defined [`expression`](#reference-expression) strings mapped to a variable name that may be referenced throughout the style. If an expression references a defined variable, it is replaced with the result of the corresponding evaluated expression.|No|
|**show**|`boolean,string`, `object`|A [`boolean expression`](#reference-boolean-expression) or [`conditions`](#reference-conditions) property which determines if a feature should be shown.|No, default: `true`|
|**color**|`string`, `object`|A [`color expression`](#reference-color-expression) or [`conditions`](#reference-conditions) property which determines the color blended with the feature's intrinsic color.|No, default: `Color('#FFFFFF')`|
|**meta**|`object`|A [`meta`](#reference-meta) object which determines the values of non-visual properties of the feature.|No|
|**pointSize**|`number,string`, `object`|A [`number expression`](#reference-number-expression) or [`conditions`](#reference-conditions) property which determines the size of the points in pixels.|No, default: `1`|

Additional properties are not allowed.

* **JSON schema**: [style.schema.json](schema/style.schema.json)
* **JSON schema**: [pnts.style.schema.json](../../schema/pnts.style.schema.json)

##### style.defines
##### PointCloudStyle.defines

Additional expressions that may be referenced throughout the style. If a variable references a define, it gets the result of the define's evaluated expression.
A dictionary object of defined [`expression`](#reference-expression) strings mapped to a variable name that may be referenced throughout the style. If an expression references a defined variable, it is replaced with the result of the corresponding evaluated expression.

* **Type**: `object`
* **Required**: No
* **Type of each property**: `string`

##### style.show
##### PointCloudStyle.show

Determines if a feature should be shown.
A [`boolean expression`](#reference-boolean-expression) or [`conditions`](#reference-conditions) property which determines if a feature should be shown.

* **Type**: `boolean,string`
* **Type**: `boolean,string`, `object`
* **Required**: No, default: `true`
* **Allowed values**:

##### style.color
##### PointCloudStyle.color

Determines the color blended with the feature's intrinsic color.
A [`color expression`](#reference-color-expression) or [`conditions`](#reference-conditions) property which determines the color blended with the feature's intrinsic color.

* **Type**: `string`
* **Required**: No, default: `"Color('#FFFFFF')"`
* **Allowed values**:
* **Type**: `string`, `object`
* **Required**: No, default: `Color('#FFFFFF')`

##### style.meta
##### PointCloudStyle.meta

Determines the values of non-visual properties of the feature.
A [`meta`](#reference-meta) object which determines the values of non-visual properties of the feature.

* **Type**: `object`
* **Required**: No
* **Type of each property**: `string`

##### PointCloudStyle.pointSize

A [`number expression`](#reference-number-expression) or [`conditions`](#reference-conditions) property which determines the size of the points in pixels.

* **Type**: `number,string`, `object`
* **Required**: No, default: `1`




---------------------------------------
<a name="reference-point-cloud-style"></a>
#### Point Cloud Style
<a name="reference-style"></a>
#### style

A 3D Tiles style with additional properties for Point Clouds.
A 3D Tiles style.

**Properties**

| |Type|Description|Required|
|---|----|-----------|--------|
|**defines**|`object`|Additional expressions that may be referenced throughout the style. If a variable references a define, it gets the result of the define's evaluated expression.|No|
|**show**|`boolean,string`|Determines if a feature should be shown.|No, default: `true`|
|**color**|`string`|Determines the color blended with the feature's intrinsic color.|No, default: `"Color('#FFFFFF')"`|
|**meta**|`object`|Determines the values of non-visual properties of the feature.|No|
|**pointSize**|`number,string`|Determines the size of the points in pixels.|No, default: `1`|
|**defines**|`object`|A dictionary object of defined [`expression`](#reference-expression) strings mapped to a variable name that may be referenced throughout the style. If an expression references a defined variable, it is replaced with the result of the corresponding evaluated expression.|No|
|**show**|`boolean,string`, `object`|A [`boolean expression`](#reference-boolean-expression) or [`conditions`](#reference-conditions) property which determines if a feature should be shown.|No, default: `true`|
|**color**|`string`, `object`|A [`color expression`](#reference-color-expression) or [`conditions`](#reference-conditions) property which determines the color blended with the feature's intrinsic color.|No, default: `Color('#FFFFFF')`|
|**meta**|`object`|A [`meta`](#reference-meta) object which determines the values of non-visual properties of the feature.|No|

Additional properties are not allowed.

* **JSON schema**: [pnts.style.schema.json](schema/pnts.style.schema.json)
* **JSON schema**: [style.schema.json](../../schema/style.schema.json)

##### point.cloud.style.defines
##### style.defines

Additional expressions that may be referenced throughout the style. If a variable references a define, it gets the result of the define's evaluated expression.
A dictionary object of defined [`expression`](#reference-expression) strings mapped to a variable name that may be referenced throughout the style. If an expression references a defined variable, it is replaced with the result of the corresponding evaluated expression.

* **Type**: `object`
* **Required**: No
* **Type of each property**: `string`

##### point.cloud.style.show
##### style.show

Determines if a feature should be shown.
A [`boolean expression`](#reference-boolean-expression) or [`conditions`](#reference-conditions) property which determines if a feature should be shown.

* **Type**: `boolean,string`
* **Type**: `boolean,string`, `object`
* **Required**: No, default: `true`
* **Allowed values**:

##### point.cloud.style.color
##### style.color

Determines the color blended with the feature's intrinsic color.
A [`color expression`](#reference-color-expression) or [`conditions`](#reference-conditions) property which determines the color blended with the feature's intrinsic color.

* **Type**: `string`
* **Required**: No, default: `"Color('#FFFFFF')"`
* **Allowed values**:
* **Type**: `string`, `object`
* **Required**: No, default: `Color('#FFFFFF')`

##### point.cloud.style.meta
##### style.meta

Determines the values of non-visual properties of the feature.
A [`meta`](#reference-meta) object which determines the values of non-visual properties of the feature.

* **Type**: `object`
* **Required**: No
* **Type of each property**: `string`

##### point.cloud.style.pointSize

Determines the size of the points in pixels.

* **Type**: `number,string`
* **Required**: No, default: `1`
* **Allowed values**:

---

See the full [JSON schema](./schema).

## Expressions

Expand Down
Loading