forked from Kitware/vtk-js
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add in a number of missing api.md files and cleanup many that were already there. Removed a couple classes that were no longer used. Removed some methods on classes that no longer make sense. Removed some commented out code that was not currently being used.
- Loading branch information
Showing
40 changed files
with
359 additions
and
1,258 deletions.
There are no files selected for viewing
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
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
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,57 @@ | ||
vtkActor2D is used to represent a 2D entity in a rendering scene. It inherits | ||
functions related to the actors position, and orientation from | ||
vtkProp. The actor also has scaling and maintains a reference to the | ||
defining geometry (i.e., the mapper), rendering properties, and possibly a | ||
texture map. | ||
|
||
## See Also | ||
|
||
Property2D Mapper2D | ||
|
||
## newInstance() | ||
|
||
Create an instance of vtkActor2D | ||
|
||
## getActors2D() | ||
|
||
For some exporters and other other operations we must be | ||
able to collect all the actors or volumes. These methods | ||
are used in that process. | ||
|
||
## hasTranslucentPolygonalGeometry() | ||
|
||
Does this prop have some translucent polygonal geometry? | ||
|
||
## property | ||
|
||
Set/Get the property object that controls this actors surface | ||
properties. This should be an instance of a vtkProperty object. Every | ||
actor must have a property associated with it. If one isn't specified, | ||
then one will be generated automatically. Multiple actors can share one | ||
property object. | ||
|
||
## makeProperty() | ||
|
||
Create a new property suitable for use with this type of Actor. | ||
The default is to create a vtkProperty2D. | ||
|
||
## mapper | ||
|
||
This is the method that is used to connect an actor to the end of a | ||
visualization pipeline, i.e. the mapper. This should be a subclass | ||
of vtkMapper2D. Typically vtkPolyDataMapper2D will be used. | ||
|
||
## bounds() | ||
|
||
Get the bounds for this Actor as (Xmin,Xmax,Ymin,Ymax,Zmin,Zmax). | ||
|
||
## getMTime() | ||
|
||
Get the newest "modification time" of the actor, its properties, and texture (if set). | ||
|
||
## getRedrawMTime() | ||
|
||
Return the mtime of anything that would cause the rendered image to | ||
appear differently. Usually this involves checking the mtime of the | ||
prop plus anything else it depends on such as properties, textures, | ||
etc. |
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
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
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,45 @@ | ||
## Introduction | ||
|
||
vtkCoordinate performs coordinate transformation, and represent position, in a variety of vtk coordinate systems | ||
|
||
vtkCoordinate represents position in a variety of coordinate systems, and | ||
converts position to other coordinate systems. It also supports relative | ||
positioning, so you can create a cascade of vtkCoordinate objects (no loops | ||
please!) that refer to each other. The typical usage of this object is | ||
to set the coordinate system in which to represent a position (e.g., | ||
SetCoordinateSystemToNormalizedDisplay()), set the value of the coordinate | ||
(e.g., SetValue()), and then invoke the appropriate method to convert to | ||
another coordinate system (e.g., GetComputedWorldValue()). | ||
The coordinate systems in vtk are as follows: | ||
|
||
<PRE> | ||
DISPLAY - x-y pixel values in window | ||
NORMALIZED DISPLAY - x-y (0,1) normalized values | ||
VIEWPORT - x-y pixel values in viewport | ||
NORMALIZED VIEWPORT - x-y (0,1) normalized value in viewport | ||
VIEW - x-y-z (-1,1) values in camera coordinates. (z is depth) | ||
WORLD - x-y-z global coordinate values | ||
USERDEFINED - x-y-z in User defined space | ||
</PRE> | ||
|
||
If you cascade vtkCoordinate objects, you refer to another vtkCoordinate | ||
object which in turn can refer to others, and so on. This allows you to | ||
create composite groups of things like vtkActor2D that are positioned | ||
relative to one another. Note that in cascaded sequences, each | ||
vtkCoordinate object may be specified in different coordinate systems! | ||
|
||
## See Also | ||
|
||
vtkActor2D | ||
|
||
### referenceCoordinate | ||
|
||
Make this coordinate relative to another coordinate instance. | ||
|
||
### viewport | ||
|
||
The viewport to use for calculations that require it. | ||
|
||
### value | ||
|
||
The x y z location of this point. |
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,12 @@ | ||
## Introduction | ||
|
||
vtkImageMapper provides 2D image display support for vtk. | ||
It can be associated with a vtkImageSlice prop and placed within a Renderer. | ||
|
||
## See Also | ||
|
||
vtkImageSlice vtkImageProperty vtkInteractorStyleImage | ||
|
||
### zSlice | ||
|
||
What slice of image data to display from a 3D volume. |
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
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
Oops, something went wrong.