Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
B
BigDataViewer_Core_Extension
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package registry
Container registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
BioinformaticDataCompression
BigDataViewer_Core_Extension
Commits
b8c2091e
"docs.it4i/software/git@code.it4i.cz:sccs/docs.it4i.cz.git" did not exist on "98a9b7e50228cbc480b32d259a6b81d132693ec0"
Commit
b8c2091e
authored
4 years ago
by
Tobias Pietzsch
Browse files
Options
Downloads
Patches
Plain Diff
RenderResult: add javadoc
parent
d7acca85
No related branches found
No related tags found
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
src/main/java/bdv/viewer/render/RenderResult.java
+29
-13
29 additions, 13 deletions
src/main/java/bdv/viewer/render/RenderResult.java
with
29 additions
and
13 deletions
src/main/java/bdv/viewer/render/RenderResult.java
+
29
−
13
View file @
b8c2091e
...
...
@@ -6,49 +6,65 @@ import net.imglib2.realtransform.AffineTransform3D;
import
net.imglib2.type.numeric.ARGBType
;
/**
* TODO javadoc
* Provides the {@link MultiResolutionRenderer renderer} with a target image
* ({@code RandomAccessibleInterval<ARGBType>}) to render to. Provides the
* {@link RenderTarget} with the rendered image and transform etc necessary to
* display it.
*/
public
interface
RenderResult
{
/**
* TODO javadoc
* Allocate storage such that {@link #getScreenImage()} holds an image of
* {@code width * height}.
* <p>
* (Called by the {@link MultiResolutionRenderer renderer}.)
*/
void
init
(
int
width
,
int
height
);
/**
* TODO javadoc
* Get the image to render to.
* <p>
* (Called by the {@link MultiResolutionRenderer renderer}.)
*
* @return
* @return
the image to render to
*/
// TODO: rename getTargetImage() ???
RandomAccessibleInterval
<
ARGBType
>
getScreenImage
();
/**
* TODO javadoc
* Get the viewer transform used to render image.
* This is with respect to the screen resolution (doesn't include scaling).
* Get the viewer transform used to render image. This is with respect to
* the screen resolution (doesn't include scaling).
* <p>
* (Called by the {@link MultiResolutionRenderer renderer} to set the
* transform.)
*/
AffineTransform3D
getViewerTransform
();
/**
*
TODO javadoc
*
Get the scale factor from target coordinates to screen resolution.
*/
double
getScaleFactor
();
/**
*
TODO javadoc
*
Set the scale factor from target coordinates to screen resolution.
*/
void
setScaleFactor
(
double
scaleFactor
);
/**
* Fill in {@code interval} with data from {@code patch},
* scaled by the relative scale between this {@code RenderResult} and {@code patch},
* and shifted such that {@code (0,0)} of the {@code patch} is placed at {@code (ox,oy)} of this {@code RenderResult}
* Fill in {@code interval} with data from {@code patch}, scaled by the
* relative scale between this {@code RenderResult} and {@code patch}, and
* shifted such that {@code (0,0)} of the {@code patch} is placed at
* {@code (ox,oy)} of this {@code RenderResult}
* <p>
* Note that only data in {@code interval} will be modified, although the scaled and shifted {@code patch} might fall partially outside.
* Note that only data in {@code interval} will be modified, although the
* scaled and shifted {@code patch} might fall partially outside.
*/
void
patch
(
final
RenderResult
patch
,
final
Interval
interval
,
final
double
ox
,
final
double
oy
);
/**
* Notify that the {@link #getScreenImage() target image} data was changed.
* <p>
* (Called by the {@link MultiResolutionRenderer renderer}.)
*/
void
setUpdated
();
}
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment