FrameIT
CircleFact Class Reference

A Circle that is made out of a middle point, a plane and a radius More...

Inheritance diagram for CircleFact:
FactWrappedCRTP< CircleFact >

Public Member Functions

 CircleFact ()
 
 CircleFact (string pid1, string pid2, float radius, Vector3 normal)
 Standard Constructor: Initiates PidCenter, PidBase, radius,dir1,dir2, Fact._URI and creates MMT Fact Server-Side More...
 
 CircleFact (string Pid1, string Pid2, float radius, Vector3 normal, SOMDoc _ServerDefinition)
 Bypasses initialization of new MMT Fact by using existend URI, which is not checked for existence. More...
 
override MMTFact MakeMMTDeclaration ()
 Constructs struct for right-angled MMT Fact AddFactResponse More...
 
override SOMDoc Defines ()
 
- Public Member Functions inherited from FactWrappedCRTP< CircleFact >
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 IEnumerator parseFact (List< Fact > ret, MMTFact fact)
 parses the Circlefact response of the MMT-Server More...
 

Public Attributes

string PidCenter
 defining the middle point of the circle More...
 
string PidBase
 defining the base point of the circle plane More...
 
float radius
 radius of the circle More...
 
Vector3 normal
 normal vector of the plane More...
 

Protected Member Functions

override void RecalculateTransform ()
 
override string generateLabel (FactRecorder name_space)
 auto-generates GetLabel using generation variable(s) e.g. LabelId; if custom GetLabel is set, tries to restore original generated GetLabel without resetting _CustomLabel. If original GetLabel is already taken, a new one will be generated. More...
 
override string[] GetDependentFactIds ()
 
override bool EquivalentWrapped (CircleFact f1, CircleFact f2)
 Compares f1 against f2 . More...
 
override Fact _ReInitializeMe (Dictionary< string, string > old_to_new)
 
- Protected Member Functions inherited from FactWrappedCRTP< CircleFact >
 FactWrappedCRTP ()
 
abstract bool EquivalentWrapped (T f1, T f2)
 CRTP step of Equivalent(Fact) and Equivalent(Fact, Fact) More...
 
bool DependentFactsEquivalent (T f1, T f2)
 

Properties

PointFact PointCenter [get]
 
PointFact PointBase [get]
 
override bool HasDependentFacts [get]
 

Detailed Description

A Circle that is made out of a middle point, a plane and a radius

Constructor & Destructor Documentation

◆ CircleFact() [1/3]

CircleFact.CircleFact ( )

Only being used by JsonReader to initiate empty Facts.

See also
SOMDocManager

◆ CircleFact() [2/3]

CircleFact.CircleFact ( string  pid1,
string  pid2,
float  radius,
Vector3  normal 
)

Standard Constructor: Initiates PidCenter, PidBase, radius,dir1,dir2, Fact._URI and creates MMT Fact Server-Side

Parameters
pid1sets PidCenter
pid2sets PidBase
radiussets radius
normalsets normal

◆ CircleFact() [3/3]

CircleFact.CircleFact ( string  Pid1,
string  Pid2,
float  radius,
Vector3  normal,
SOMDoc  _ServerDefinition 
)

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

Parameters
Pid1sets PidCenter
Pid2sets PidBase
radiussets radius
normalsets normal
backendURIMMT URI

Member Function Documentation

◆ _ReInitializeMe()

override Fact CircleFact._ReInitializeMe ( Dictionary< string, string >  old_to_new)
protected

◆ Defines()

override SOMDoc CircleFact.Defines ( )

◆ EquivalentWrapped()

override bool CircleFact.EquivalentWrapped ( CircleFact  f1,
CircleFact  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 CircleFact.generateLabel ( FactRecorder  name_space)
protected

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

Returns
auto-generated GetLabel

◆ GetDependentFactIds()

override string[] CircleFact.GetDependentFactIds ( )
protected

◆ MakeMMTDeclaration()

override MMTFact CircleFact.MakeMMTDeclaration ( )

Constructs struct for right-angled MMT Fact AddFactResponse

Parameters
Pid1PidCenter
p2URIPidBase
radiusradius
Returns
struct for AddFactResponse

◆ parseFact()

static new IEnumerator CircleFact.parseFact ( List< Fact ret,
MMTFact  fact 
)
static

parses the Circlefact response of the MMT-Server



◆ RecalculateTransform()

override void CircleFact.RecalculateTransform ( )
protected

Member Data Documentation

◆ normal

Vector3 CircleFact.normal

normal vector of the plane

◆ PidBase

string CircleFact.PidBase

defining the base point of the circle plane

◆ PidCenter

string CircleFact.PidCenter

defining the middle point of the circle

◆ radius

float CircleFact.radius

radius of the circle

Property Documentation

◆ HasDependentFacts

override bool CircleFact.HasDependentFacts
get

◆ PointBase

PointFact CircleFact.PointBase
get

◆ PointCenter

PointFact CircleFact.PointCenter
get

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