Volume agent rendering #419
There are no files selected for viewing
This file contains hidden or 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 hidden or 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 hidden or 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 |
|---|---|---|
| @@ -1,40 +1,136 @@ | ||
| import { Euler, Object3D, Vector3 } from "three"; | ||
|
|
||
| import { | ||
| HasThreeJsContext, | ||
| Lut, | ||
| Volume, | ||
| VolumeDrawable, | ||
| } from "@aics/volume-viewer"; | ||
|
|
||
| import { AgentData } from "../simularium/types"; | ||
|
|
||
|
Comment on lines
-7
to
-12
|
||
| export default class VolumeModel { | ||
| // TODO what to do with this `cancelled` property? Type check fails without it. | ||
| // When should it be set, if ever; what should it be used for, if anything? | ||
| public cancelled = false; | ||
| private drawable?: VolumeDrawable; | ||
|
Contributor
There was a problem hiding this comment. If I recall, I think the "cancelled" property mentioned above is for when the trajectory has been changed but there is still geometry download requests in-flight. We can use |
||
| private volume?: Volume; | ||
| private channelsEnabled: boolean[] = []; | ||
|
|
||
| private setEnabledChannels(channels: number[]): void { | ||
| if (!this.volume || !this.drawable) { | ||
| this.channelsEnabled = []; | ||
| return; | ||
| } | ||
| const { numChannels } = this.volume.imageInfo; | ||
| this.channelsEnabled = new Array(numChannels).fill(false); | ||
|
|
||
| for (const channel of channels) { | ||
| if (channel < numChannels) { | ||
| this.channelsEnabled[channel] = true; | ||
| } | ||
| } | ||
|
|
||
| for (const [channelIndex, enabled] of this.channelsEnabled.entries()) { | ||
| this.drawable.setVolumeChannelEnabled(channelIndex, enabled); | ||
| } | ||
| } | ||
|
|
||
| public setImage(volumeObject: Volume): void { | ||
| this.volume = volumeObject; | ||
| this.drawable = new VolumeDrawable(this.volume, {}); | ||
| this.volume.addVolumeDataObserver(this); | ||
| this.drawable.setBrightness(0.7); | ||
| this.drawable.setGamma(0.15, 0.9, 1.0); | ||
| this.drawable.setDensity(0.7); | ||
| } | ||
|
|
||
| public setAgentData(data: AgentData): void { | ||
| if (this.drawable) { | ||
| this.drawable.setTranslation(new Vector3(data.x, data.y, data.z)); | ||
| this.drawable.setRotation( | ||
| new Euler(data.xrot, data.yrot, data.zrot) | ||
| ); | ||
| const r = data.cr * 2; | ||
| this.drawable.setScale(new Vector3(r, r, r)); | ||
| // Always defined if `drawable` is, but ts doesn't know that. | ||
| if (this.volume) { | ||
| // Volume agent data may use subpoint 0 as time | ||
| const numPoints = data.subpoints.length; | ||
| const time = numPoints > 0 ? data.subpoints[0] : 0; | ||
| if (this.volume.loadSpec.time !== time) { | ||
| this.volume.updateRequiredData({ time }); | ||
| } | ||
| // If there are more subpoints, they are enabled channel idxes. | ||
| // Otherwise, just channel 0 is enabled. | ||
| const channels = numPoints > 1 ? data.subpoints.slice(1) : [0]; | ||
| this.setEnabledChannels(channels); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| public loadInitialData(): void { | ||
| this.volume?.loader?.loadVolumeData(this.volume); | ||
| } | ||
|
|
||
| public getObject3D(): Object3D | undefined { | ||
| return this.drawable?.sceneRoot; | ||
| } | ||
|
|
||
| public onChannelLoaded(vol: Volume, channelIndex: number): void { | ||
| if (this.drawable) { | ||
| const isEnabled = this.channelsEnabled[channelIndex]; | ||
| this.drawable.setVolumeChannelEnabled(channelIndex, isEnabled); | ||
| this.drawable.updateScale(); | ||
| this.drawable.onChannelLoaded([channelIndex]); | ||
| if (this.volume) { | ||
| const histo = this.volume.getHistogram(channelIndex); | ||
| const min = histo.findBinOfPercentile(0.5); | ||
| const max = histo.findBinOfPercentile(0.983); | ||
|
Comment on lines
+94
to
+95
Contributor
There was a problem hiding this comment. I saw the note you had in the PR description, maybe tag all the hardcoded values with a TODO so they're easier to track down? Totally optional |
||
| const lut = new Lut().createFromMinMax(min, max); | ||
| this.volume.setLut(channelIndex, lut); | ||
| } | ||
| this.drawable.updateLuts(); | ||
| this.drawable.fuse(); | ||
| } | ||
| } | ||
|
|
||
| public onBeforeRender( | ||
| context: HasThreeJsContext, | ||
| width: number, | ||
| height: number, | ||
| orthoScale: number | undefined | ||
| ): void { | ||
| if (this.drawable) { | ||
| const isOrtho = orthoScale !== undefined; | ||
| this.drawable.setIsOrtho(isOrtho); | ||
| if (isOrtho) { | ||
| this.drawable.setOrthoScale(orthoScale); | ||
| } | ||
| this.drawable.setResolution(width, height); | ||
|
Contributor
There was a problem hiding this comment. What does setting the resolution here do? |
||
| this.drawable.onAnimate(context); | ||
| } | ||
| } | ||
|
|
||
| public setSize(width: number, height: number): void { | ||
| this.drawable?.setResolution(width, height); | ||
| } | ||
|
|
||
| // METHODS FROM `VolumeDataObserver` in volume-viewer | ||
|
|
||
| public onVolumeData(_volume: Volume, channels: number[]): void { | ||
| this.drawable?.updateScale(); | ||
| this.drawable?.onChannelLoaded(channels); | ||
| } | ||
|
|
||
| public onVolumeChannelAdded( | ||
| _volume: Volume, | ||
| newChannelIndex: number | ||
| ): void { | ||
| this.drawable?.onChannelAdded(newChannelIndex); | ||
| } | ||
|
|
||
| public onVolumeLoadError(_volume: Volume, error: unknown): void { | ||
| console.error("Volume load error", error); | ||
| } | ||
| } | ||
This file contains hidden or 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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why do you need to bind the callback here? :0