FrameIT
OnLineFact Class Reference

A PointFact on a AbstractLineFact More...

Inheritance diagram for OnLineFact:
FactWrappedCRTP< OnLineFact >

Public Member Functions

 OnLineFact ()
 
 OnLineFact (OnLineFact fact, Dictionary< string, string > old_to_new, FactOrganizer organizer)
 Copies fact by initiating new MMT Fact. More...
 
 OnLineFact (string pid, string rid, FactOrganizer organizer)
 Standard Constructor More...
 
 OnLineFact (string pid, string rid, string uri, FactOrganizer organizer)
 Bypasses initialization of new MMT Fact by using existend URI, which is not checked for existence. More...
 
override Boolean hasDependentFacts ()
 
Returns
true if Fact depends on other Facts; equivalent to getDependentFactIds returns non empty array
More...
 
override string[] getDependentFactIds ()
 
override GameObject instantiateDisplay (GameObject prefab, Transform transform)
 Initiates a prefab at transform e.g. by setting Label. More...
 
override int GetHashCode ()
 canonical More...
 
- Public Member Functions inherited from FactWrappedCRTP< OnLineFact >
override bool Equivalent (Fact f2)
 Compares this against f2 . More...
 
override bool Equivalent (Fact f1, Fact f2)
 Compares f1 against f2 . More...
 

Static Public Member Functions

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

Public Attributes

string Pid
 PointFact.Id More...
 
string Rid
 AbstractLineFact.Id 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 (OnLineFact f1, OnLineFact f2)
 Compares f1 against f2 . More...
 
- Protected Member Functions inherited from FactWrappedCRTP< OnLineFact >
 FactWrappedCRTP ()
 
 FactWrappedCRTP (FactOrganizer organizer)
 
 FactWrappedCRTP (FactWrappedCRTP< T > fact, FactOrganizer organizer)
 
abstract bool EquivalentWrapped (T f1, T f2)
 CRTP step of Equivalent(Fact) and Equivalent(Fact, Fact) More...
 

Private Member Functions

void init (string pid, string rid)
 Initiates Pid, Rid, Fact._URI and creates MMT Fact Server-Side More...
 

Detailed Description

Constructor & Destructor Documentation

◆ OnLineFact() [1/4]

OnLineFact.OnLineFact ( )

Only being used by JsonReader to initiate empty Facts.

See also
JSONManager

◆ OnLineFact() [2/4]

OnLineFact.OnLineFact ( OnLineFact  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

◆ OnLineFact() [3/4]

OnLineFact.OnLineFact ( string  pid,
string  rid,
FactOrganizer  organizer 
)

Standard Constructor

Parameters
pidsets Pid
ridsets Rid
organizersets Fact._Facts

◆ OnLineFact() [4/4]

OnLineFact.OnLineFact ( string  pid,
string  rid,
string  uri,
FactOrganizer  organizer 
)

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

Parameters
pidsets Pid
ridsets Rid
uriMMT URI
organizersets Fact._Facts

Member Function Documentation

◆ EquivalentWrapped()

override bool OnLineFact.EquivalentWrapped ( OnLineFact  f1,
OnLineFact  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 OnLineFact.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

◆ getDependentFactIds()

override string[] OnLineFact.getDependentFactIds ( )

Returns
array of Fact Ids on which this Fact depends.

AngleFact needs 3 PointFacts to be defined.

◆ GetHashCode()

override int OnLineFact.GetHashCode ( )

canonical

Returns
unique-ish Hash

◆ hasDependentFacts()

override Boolean OnLineFact.hasDependentFacts ( )

Returns
true if Fact depends on other Facts; equivalent to getDependentFactIds returns non empty array

◆ init()

void OnLineFact.init ( string  pid,
string  rid 
)
private

Initiates Pid, Rid, Fact._URI and creates MMT Fact Server-Side

Parameters
pidsets Pid
ridsets Rid

◆ instantiateDisplay()

override GameObject OnLineFact.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 OnLineFact OnLineFact.parseFact ( Scroll.ScrollFact  fact)
static

Parses Scroll.ScrollFact to actual Fact

Parameters
factinstance to be parsed
Returns
parsed Fact

Member Data Documentation

◆ Pid

string OnLineFact.Pid

◆ Rid

string OnLineFact.Rid

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