FrameIT
LineFact Class Reference

Line within 3D Space of finite length More...

Inheritance diagram for LineFact:
AbstractLineFactWrappedCRTP< LineFact >

Public Member Functions

 LineFact ()
 
 LineFact (LineFact fact, Dictionary< string, string > old_to_new, FactOrganizer organizer)
 
 LineFact (string pid1, string pid2, string backendURI, FactOrganizer organizer)
 
 LineFact (string pid1, string pid2, FactOrganizer organizer)
 
override GameObject instantiateDisplay (GameObject prefab, Transform transform)
 Initiates a prefab at transform e.g. by setting Label. More...
 

Static Public Member Functions

static new LineFact parseFact (Scroll.ScrollFact fact)
 Parses Scroll.ScrollFact to actual Fact More...
 

Public Attributes

float Distance
 Distance between AbstractLineFact.Pid1 and AbstractLineFact.Pid2 More...
 

Protected Member Functions

override string generateLabel ()
 auto-generates Label using generation variable(s) e.g. LabelId; if custom Label is set, tries to restore original generated Label without resetting _CustomLabel. If original Label is already taken, a new one will be generated. More...
 
override bool EquivalentWrapped (LineFact f1, LineFact f2)
 Compares f1 against f2 . More...
 
- Protected Member Functions inherited from AbstractLineFactWrappedCRTP< LineFact >
 AbstractLineFactWrappedCRTP ()
 
 AbstractLineFactWrappedCRTP (AbstractLineFactWrappedCRTP< T > fact, Dictionary< string, string > old_to_new, FactOrganizer organizer)
 
 AbstractLineFactWrappedCRTP (string pid1, string pid2, FactOrganizer organizer)
 
 AbstractLineFactWrappedCRTP (string pid1, string pid2, string backendURI, FactOrganizer organizer)
 
override bool EquivalentWrapped (AbstractLineFact f1, AbstractLineFact f2)
 Compares f1 against f2 . More...
 
abstract bool EquivalentWrapped (T f1, T f2)
 CRTP step of EquivalentWrapped(AbstractLineFact, AbstractLineFact) More...
 

Private Member Functions

void init (string pid1, string pid2)
 Initiates AbstractLineFact.Pid1, AbstractLineFact.Pid2, Fact._URI and creates MMT Fact Server-Side More...
 
void SetDistance ()
 Calculates and sets Distance; More...
 

Detailed Description

Line within 3D Space of finite length

Constructor & Destructor Documentation

◆ LineFact() [1/4]

LineFact.LineFact ( )

Only being used by JsonReader to initiate empty Facts.

See also
JSONManager

◆ LineFact() [2/4]

LineFact.LineFact ( LineFact  fact,
Dictionary< string, string >  old_to_new,
FactOrganizer  organizer 
)

Copies fact by initiating new MMT Fact.

Parameters
factFact to be copied
old_to_newDictionary mapping fact .getDependentFactIds in fact .Fact._Facts to corresponding Fact.Id in organizer
organizersets _Facts

◆ LineFact() [3/4]

LineFact.LineFact ( string  pid1,
string  pid2,
string  backendURI,
FactOrganizer  organizer 
)

Bypasses initialization of new MMT Fact by using existend URI, which is not checked for existence.

Parameters
pid1sets Pid1
pid2sets Pid2
backendURIMMT URI
organizersets Fact._Facts

◆ LineFact() [4/4]

LineFact.LineFact ( string  pid1,
string  pid2,
FactOrganizer  organizer 
)

Standard Constructor

Parameters
pid1sets AbstractLineFact.Pid1
pid2sets AbstractLineFact.Pid2
organizersets Fact._Facts

Member Function Documentation

◆ EquivalentWrapped()

override bool LineFact.EquivalentWrapped ( LineFact  f1,
LineFact  f2 
)
protected

Compares f1 against f2 .

Parameters
f1Fact to compare to
f2Fact to compare to
Returns
true if f2 is semantical very similar to f1

◆ generateLabel()

override string LineFact.generateLabel ( )
protected

auto-generates Label using generation variable(s) e.g. LabelId; if custom Label is set, tries to restore original generated Label without resetting _CustomLabel. If original Label is already taken, a new one will be generated.

Returns
auto-generated Label

◆ init()

void LineFact.init ( string  pid1,
string  pid2 
)
private

Initiates AbstractLineFact.Pid1, AbstractLineFact.Pid2, Fact._URI and creates MMT Fact Server-Side

Parameters
pid1sets AbstractLineFact.Pid1
pid2sets AbstractLineFact.Pid2

◆ instantiateDisplay()

override GameObject LineFact.instantiateDisplay ( GameObject  prefab,
Transform  transform 
)

Initiates a prefab at transform e.g. by setting Label.

Does not set Representation.

Parameters
prefabGameObject Prefab that will represent this Fact
transformTransform where to initiate prefab
Returns

◆ parseFact()

static new LineFact LineFact.parseFact ( Scroll.ScrollFact  fact)
static

Parses Scroll.ScrollFact to actual Fact

Parameters
factinstance to be parsed
Returns
parsed Fact

◆ SetDistance()

void LineFact.SetDistance ( )
private

Calculates and sets Distance;

AbstractLineFact.Pid1 and AbstractLineFact.Pid2 needs to be set first.

Member Data Documentation

◆ Distance

float LineFact.Distance

The documentation for this class was generated from the following file: