Table of Contents

Class VolumeModel

Namespace
LightningChartLib.WinForms.Charting.Views.View3D
Assembly
LightningChart.WinForms.Charting.NET4.dll

Volume model.

[TypeConverter(typeof(ExpandableObjectConverter))]
public class VolumeModel : TransparencyRenderItem, IChartNode, IDisposable, IHighlightingItem
Inheritance
VolumeModel
Implements
Inherited Members

Constructors

VolumeModel()

Constructor.

public VolumeModel()

VolumeModel(LightningChart)

Constructor.

public VolumeModel(LightningChart chart)

Parameters

chart LightningChart

Parent.

VolumeModel(LightningChart, byte[], int, int, int)

Constructor.

public VolumeModel(LightningChart chart, byte[] data, int width, int height, int slicesAmount)

Parameters

chart LightningChart

Parent.

data byte[]

Texture map.

width int

Texture map width.

height int

Texture map height.

slicesAmount int

Amount of slices.

VolumeModel(LightningChart, Bitmap, int)

Constructor.

public VolumeModel(LightningChart chart, Bitmap img, int amountOfSlices)

Parameters

chart LightningChart

Parent.

img Bitmap

Texture map.

amountOfSlices int

Amount of slices on texture map.

VolumeModel(LightningChart, Bitmap[])

Constructor.

public VolumeModel(LightningChart chart, Bitmap[] imgs)

Parameters

chart LightningChart

Parent.

imgs Bitmap[]

An array of slices.

VolumeModel(LightningChart, string)

Constructor.

public VolumeModel(LightningChart chart, string folderPath)

Parameters

chart LightningChart

Parent.

folderPath string

Path to the folder with slices.

VolumeModel(LightningChart, string, int)

Constructor.

public VolumeModel(LightningChart chart, string filePath, int amountOfSlices)

Parameters

chart LightningChart

Parent.

filePath string

Path to the texture map.

amountOfSlices int

Amount of slices on texture map.

VolumeModel(View3D)

Constructor. Use primary axis for axis binding.

public VolumeModel(View3D owner)

Parameters

owner View3D

Parent.

VolumeModel(View3D, Axis3DBinding, Axis3DBinding, Axis3DBinding)

Constructor.

public VolumeModel(View3D owner, Axis3DBinding xAxis, Axis3DBinding yAxis, Axis3DBinding zAxis)

Parameters

owner View3D

Parent.

xAxis Axis3DBinding

X-axis binding.

yAxis Axis3DBinding

Y-axis binding.

zAxis Axis3DBinding

Z-axis binding.

VolumeModel(string)

Constructor.

public VolumeModel(string folderPath)

Parameters

folderPath string

Path to the folder with slices.

VolumeModel(string, int)

Constructor.

public VolumeModel(string filePath, int AmountOfSlices)

Parameters

filePath string

Path to the texture map.

AmountOfSlices int

Amount of slices on texture map.

Properties

Brightness

Brightness option of the transfer function

public PointRGB Brightness { get; set; }

Property Value

PointRGB

ClipColorRange

skip color for volume model not to draw

public bool ClipColorRange { get; set; }

Property Value

bool

ColorRangeToClip

Clip color range of VolumeModel where color component values between 0.0-1, inclusive.

public RangeRGB ColorRangeToClip { get; set; }

Property Value

RangeRGB

Darkness

Darkness option of the transfer function

public PointRGB Darkness { get; set; }

Property Value

PointRGB

Data

Model bitmap data.

[Browsable(false)]
public Bitmap[] Data { get; set; }

Property Value

Bitmap[]

EmptySpaceSkipping

Sampling rate for empty space skipping settings. Low level increases performance, but can reveal some artifacts.

public int EmptySpaceSkipping { get; set; }

Property Value

int

Opacity

Opacity for semi-transparent volume rendering functions

public double Opacity { get; set; }

Property Value

double

Position

Position.

public PointDoubleXYZ Position { get; set; }

Property Value

PointDoubleXYZ

RayFunction

Enum specifies Ray Function, which is used to render the model.

public RayFunction RayFunction { get; set; }

Property Value

RayFunction

Rotation

Rotating angles, in degrees

public PointDoubleXYZ Rotation { get; set; }

Property Value

PointDoubleXYZ

SamplingRateOptions

Set of setting for Sampling Rate Manager

public SamplingRateOptions SamplingRateOptions { get; set; }

Property Value

SamplingRateOptions

Size

Point size

public SizeDoubleXYZ Size { get; set; }

Property Value

SizeDoubleXYZ

SliceRange

Slice Range settings per every dimension

public RangeXYZ SliceRange { get; set; }

Property Value

RangeXYZ

Smoothness

Smoothness factor for Iso-Surface rendering

public double Smoothness { get; set; }

Property Value

double

Threshold

Threshold settings, to cut away unaccepted part of the model

public RangeRGB Threshold { get; set; }

Property Value

RangeRGB

Visible

Visible.

public bool Visible { get; set; }

Property Value

bool

XAxisBinding

X axis binding

public Axis3DBinding XAxisBinding { get; set; }

Property Value

Axis3DBinding

YAxisBinding

Y axis binding

public Axis3DBinding YAxisBinding { get; set; }

Property Value

Axis3DBinding

ZAxisBinding

Z axis binding

public Axis3DBinding ZAxisBinding { get; set; }

Property Value

Axis3DBinding

Methods

Construct()

Construct object.

protected void Construct()

Dispose(bool)

Clean up any resources being used.

protected override void Dispose(bool disposing)

Parameters

disposing bool

true if managed resources should be disposed, otherwise false.

IsPositionOver(int, int)

Is position over item.

public bool IsPositionOver(int x, int y)

Parameters

x int

x-coordinate

y int

y-coordinate

Returns

bool

true if position is over item, false otherwise

LoadFromBytes(byte[], int, int, int)

Receive a texture map as byte array and assigns it to the volume data.

public void LoadFromBytes(byte[] data, int width, int height, int slicesAmount)

Parameters

data byte[]

Slice map data.

width int

Slice map width.

height int

Slice map height.

slicesAmount int

Amount of slices in the slice map.

LoadFromSliceMap(Bitmap, int)

Receive a texture map and assigns it to the volume data.

public void LoadFromSliceMap(Bitmap img, int AmountOfSlices)

Parameters

img Bitmap

Texture map.

AmountOfSlices int

Amount of slices on texture map.

LoadFromSliceMap(string, int)

Receive a texture map and set assigns it to the volume data.

public void LoadFromSliceMap(string filePath, int amountOfSlices)

Parameters

filePath string

Path to the texture map.

amountOfSlices int

Amount of slices per side.

LoadFromSlices(Bitmap[])

Receive an array of slices and assign it to the volume data.

public bool LoadFromSlices(Bitmap[] imgs)

Parameters

imgs Bitmap[]

An array of slices.

Returns

bool

True, if can load data, false otherwise.

LoadFromSlices(string)

Receive an array of slices and assign it to the volume data.

public void LoadFromSlices(string folderPath)

Parameters

folderPath string

Path to the folder with slices.

SetChart(LightningChart)

Set Chart.

public void SetChart(LightningChart chart)

Parameters

chart LightningChart
param chart M:LightningChartLib.WinForms.Charting.Views.View3D.VolumeModel.SetChart(LightningChartLib.WinForms.Charting.LightningChart)

ToString()

Convert class description to string.

public override string ToString()

Returns

string

Class description as a string.