Skip to content

BH.oM.Humans.ViewQuality.Avalue

Class structure

Implemented interfaces and base types

The Avalue is inheriting from the following base type(s) and implements the following interfaces:

Properties

Defining properties

The following properties are defined on the class

Name Type Description Quantity
AValue double Percentage of the cone of vision occupied by the clipped activity area. -
Occulsion double Percentage of the cone of vision occupied by heads occluding the activity area. -
FullActivityArea Polyline Activity area projected to the spectator's viewing plane. -
ClippedActivityArea Polyline Resulting Polyline after clipping the full activity area with the cone of vision. -
ConeOfVision Polyline Effective cone of vision orientated to the spectator. -
ReferencePoint Point Point representing the spectator's singular eye reference. -
OccludingHeads List<Polyline> Polylines of the spectator heads occluding the view of the activity area. -

Inherited properties

The following properties are inherited from the base class of the object

Name Type Description Quantity
ObjectId IComparable - -
ResultCase IComparable - -
TimeStep double - -

Derived properties

The following properties are defined as extension methods in one of the BHoM_Engines

Name Type Description Quantity Engine
AllIdentifierProperties List<string> Gets the name of all properties of the result that are of identifier types. This is all properties tagged with any IdentifierAttribute. - Results_Engine
ObjectIdentifierProperties List<string> Gets the name of all properties of the result that are of ObjectIdentifier types. This is all properties tagged with the ObjectIdentifierAttribute. - Results_Engine
ResultPropertyKeys List<string> Returns the result value carrying properties available for the result type provided. Currently only supported for IResultItem and IResultCollection<IResultItem> type results. - Results_Engine
ScenarioIdentifierProperties List<string> Gets the name of all properties of the result that are of Scenario types. This is all properties tagged with the ScenarioIdentifierAttribute. - Results_Engine

Code and Schema

C# implementation

C#
public class Avalue : BH.oM.Humans.ViewQuality.ViewQualityResult,
BH.oM.Analytical.Results.IObjectIdResult,
BH.oM.Analytical.Results.IResult,
BH.oM.Base.IObject,
System.IComparable<BH.oM.Analytical.Results.IResult>,
BH.oM.Base.IImmutable,
BH.oM.Analytical.Results.ICasedResult,
BH.oM.Analytical.Results.ITimeStepResult

Assembly: Humans_oM.dll

The C# class definition is available on github:

All history and changes of the class can be found by inspection the history.

JSON Schema implementation

The object is defined as a JSON schema. You can validate a JSON instance against this schema by reference. To do this, use the schema reference below in a validator like this one.

JSON Schema
{
 "$ref" : "https://raw.githubusercontent.com/BHoM/BHoM_JSONSchema/develop/Humans_oM/ViewQuality/Avalue.json"
}

The JSON Schema is available on github here: