-
-
Notifications
You must be signed in to change notification settings - Fork 370
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fix(Docs): Add new API docs; add small method to OrientationMarkerWidget
- Loading branch information
Showing
3 changed files
with
89 additions
and
48 deletions.
There are no files selected for viewing
13 changes: 13 additions & 0 deletions
13
Sources/Interaction/Widgets/OrientationMarkerWidget/api.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
### setEnabled(enabling) | ||
|
||
Sets the widget enabled status, i.e. to show the widget or not. | ||
|
||
### setViewportCorner(vtkOrientationMarkerWidget.Corner) | ||
|
||
Sets which corner to put the widget's viewport. Defaults to | ||
BOTTOM_LEFT. | ||
|
||
### setViewportSize(sizeFactor) | ||
|
||
Sets the viewport size. The sizeFactor should be between 0.0 and 1.0. | ||
It says how much of the main render window to color. Defaults to 0.2. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,71 @@ | ||
### setResolution(resolution) | ||
|
||
Sets the cube face resolution. Defaults to 200. | ||
|
||
### setFontStyle(style) | ||
|
||
Sets the font style. This is any valid CSS font style, e.g. normal, | ||
bold, etc. Defaults to "normal". | ||
|
||
### setFontFamily(family) | ||
|
||
Sets the font family. This is any valid CSS font family name. Defaults | ||
to "Arial". | ||
|
||
### setFontColor(color) | ||
|
||
Sets the font color. This is any valid CSS color. Defaults to "black". | ||
|
||
### setEdgeThickness(thickness) | ||
|
||
Edge thickness is a value between 0.0 and 1.0, and represents the | ||
fraction of the face resolution to cover (for one edge). Defaults to | ||
0.1. | ||
|
||
If the thickness is 0, then no edge is rendered. | ||
|
||
### setEdgeColor(color) | ||
|
||
Sets the edge color. Defaults to black. | ||
|
||
### setXPlusFaceProperty({ text, faceColor}) | ||
|
||
Sets the +X face property. | ||
|
||
This takes an object, where you can optionally set the face text | ||
or the face color, e.g. { text: 'Text', faceColor: '#0000ff' }. | ||
|
||
### setXMinusFaceProperty({ text, faceColor}) | ||
|
||
Sets the -X face property. | ||
|
||
This takes an object, where you can optionally set the face text | ||
or the face color, e.g. { text: 'Text', faceColor: '#0000ff' }. | ||
|
||
### setYPlusFaceProperty({ text, faceColor}) | ||
|
||
Sets the +Y face property. | ||
|
||
This takes an object, where you can optionally set the face text | ||
or the face color, e.g. { text: 'Text', faceColor: '#0000ff' }. | ||
|
||
### setYMinusFaceProperty({ text, faceColor}) | ||
|
||
Sets the -Y face property. | ||
|
||
This takes an object, where you can optionally set the face text | ||
or the face color, e.g. { text: 'Text', faceColor: '#0000ff' }. | ||
|
||
### setZPlusFaceProperty({ text, faceColor}) | ||
|
||
Sets the +Z face property. | ||
|
||
This takes an object, where you can optionally set the face text | ||
or the face color, e.g. { text: 'Text', faceColor: '#0000ff' }. | ||
|
||
### setZMinusFaceProperty({ text, faceColor}) | ||
|
||
Sets the -Z face property. | ||
|
||
This takes an object, where you can optionally set the face text | ||
or the face color, e.g. { text: 'Text', faceColor: '#0000ff' }. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters