Struct SampleHitInfo

Sample hit test information

Implements

System.IEquatable<SampleHitInfo>

Inherited Members

System.ValueType.ToString()

System.Object.Equals(System.Object, System.Object)

System.Object.GetType()

System.Object.ReferenceEquals(System.Object, System.Object)

Namespace: Phoenix.Input

Assembly: Phoenix.Plugin.Input.dll

Syntax

public struct SampleHitInfo : IEquatable<SampleHitInfo>

Constructors

View Source

SampleHitInfo(SampleHitInfo.Element, Double, Double, Sample, Sample)

Initializes a new instance of the SampleHitInfo struct

Declaration

public SampleHitInfo(SampleHitInfo.Element element, double minExtent, double maxExtent, Sample minSample, Sample maxSample)

Parameters

Type	Name	Description
SampleHitInfo.Element	element	Element hit
System.Double	minExtent	Minimum extent of sample segment
System.Double	maxExtent	Maximum extent of sample segment
Sample	minSample	Minimum sample belonging to segment
Sample	maxSample	Maximum sample belonging to segment

Properties

View Source

HitTest

Gets or sets the element hit

Declaration

public SampleHitInfo.Element HitTest { readonly get; set; }

Property Value

Type	Description
SampleHitInfo.Element

View Source

MaxExtent

Gets or sets the max extent of sample segment

Declaration

public double MaxExtent { readonly get; set; }

Property Value

Type	Description
System.Double

View Source

MaxSample

Gets or sets max sample in segment

Declaration

public Sample MaxSample { readonly get; set; }

Property Value

Type	Description
Sample

View Source

MinExtent

Gets or sets the min extent of sample segment

Declaration

public double MinExtent { readonly get; set; }

Property Value

Type	Description
System.Double

View Source

MinSample

Gets or sets min sample in segment

Declaration

public Sample MinSample { readonly get; set; }

Property Value

Type	Description
Sample

Methods

View Source

Equals(SampleHitInfo)

Declaration

public bool Equals(SampleHitInfo other)

Parameters

Type	Name	Description
SampleHitInfo	other

Returns

Type	Description
System.Boolean

View Source

Equals(Object)

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
System.Object	obj

Returns

Type	Description
System.Boolean

Overrides

System.ValueType.Equals(System.Object)

View Source

GetHashCode()

Declaration

public override int GetHashCode()

Returns

Type	Description
System.Int32

Overrides

System.ValueType.GetHashCode()

Operators

View Source

Equality(SampleHitInfo, SampleHitInfo)

Compare two hit test results to determine if they are equal

Declaration

public static bool operator ==(SampleHitInfo first, SampleHitInfo second)

Parameters

Type	Name	Description
SampleHitInfo	first	First result
SampleHitInfo	second	Second result

Returns

Type	Description
System.Boolean	Whether two results are equal

View Source

Inequality(SampleHitInfo, SampleHitInfo)

Compare two hit test results to determine if they are not equal

Declaration

public static bool operator !=(SampleHitInfo first, SampleHitInfo second)

Parameters

Type	Name	Description
SampleHitInfo	first	First result
SampleHitInfo	second	Second result

Returns

Type	Description
System.Boolean	Whether two results are not equal

Implements

System.IEquatable<T>