wip(objectmodelv2): GetClass -> GetType

Author: m-doescode

client/src/main.cpp

@@ -70,7 +70,7 @@ int main() {
     }));
 
     for (std::shared_ptr<Instance> inst : gWorkspace()->GetChildren()) {
-        if (inst->GetClass()->className != "Part") continue;
+        if (inst->GetType()->className != "Part") continue;
         std::shared_ptr<BasePart> part = std::dynamic_pointer_cast<BasePart>(inst);
         gWorkspace()->SyncPartPhysics(part);
     }

core/src/datatypes/ref.cpp

@@ -196,7 +196,7 @@ static int inst_index(lua_State* L) {
         return 1;
     }
 
-    return luaL_error(L, "'%s' is not a valid member of %s", key.c_str(), inst->GetClass()->className.c_str());
+    return luaL_error(L, "'%s' is not a valid member of %s", key.c_str(), inst->GetType()->className.c_str());
 }
 
 // __newindex(t,k,v)
@@ -207,11 +207,11 @@ static int inst_newindex(lua_State* L) {
     // Validate property
     std::optional<PropertyMeta> meta = inst->GetPropertyMeta(key);
     if (!meta)
-        return luaL_error(L, "'%s' is not a valid member of %s", key.c_str(), inst->GetClass()->className.c_str());
+        return luaL_error(L, "'%s' is not a valid member of %s", key.c_str(), inst->GetType()->className.c_str());
     if (meta->flags & PROP_READONLY)
-        return luaL_error(L, "'%s' of %s is read-only", key.c_str(), inst->GetClass()->className.c_str());
+        return luaL_error(L, "'%s' of %s is read-only", key.c_str(), inst->GetType()->className.c_str());
     if (key == "Parent" && inst->IsParentLocked())
-        return luaL_error(L, "Cannot set property Parent (%s) of %s, parent is locked", inst->GetParent() ? inst->GetParent()->name.c_str() : "NULL", inst->GetClass()->className.c_str());
+        return luaL_error(L, "Cannot set property Parent (%s) of %s, parent is locked", inst->GetParent() ? inst->GetParent()->name.c_str() : "NULL", inst->GetType()->className.c_str());
 
     // TODO: Make this work for enums, this is not a solution!!
     result<Variant, LuaCastError> value = meta->type.descriptor->fromLuaValue(L, -1);

core/src/error/instance.h

@@ -34,5 +34,5 @@ class AssignToReadOnlyMember : public Error {
 
 class InstanceCastError : public Error {
     public:
-    inline InstanceCastError(std::string sourceClass, std::string targetClass) : Error("InstanceCastError", "Attempt to cast object of type " + sourceClass + " to incompatible type " + targetClass) {}
+    inline InstanceCastError(std::string sourceClass, std::string tarGetType) : Error("InstanceCastError", "Attempt to cast object of type " + sourceClass + " to incompatible type " + tarGetType) {}
 };

core/src/objects/annotation.h

@@ -43,5 +43,5 @@ virtual void InternalUpdateProperty(std::string name) override; \
 virtual std::vector<std::string> InternalGetProperties() override; \
 public: \
 const static InstanceType TYPE; \
-virtual const InstanceType* GetClass() override; \
+virtual const InstanceType* GetType() override; \
 private:

core/src/objects/base/instance.cpp

@@ -32,8 +32,8 @@ const InstanceType Instance::TYPE = {
     .flags = 0
 };
 
-// Instance is abstract, so it should not implement GetClass directly
-// InstanceType* Instance::GetClass() {
+// Instance is abstract, so it should not implement GetType directly
+// InstanceType* Instance::GetType() {
 //     return &TYPE_;
 // }
 
@@ -86,8 +86,8 @@ void Instance::updateAncestry(nullable std::shared_ptr<Instance> updatedChild, n
 
     // Update parent data model and workspace, if applicable
     if (GetParent() != nullptr) {
-        this->_dataModel = GetParent()->GetClass() == &DataModel::TYPE ? std::dynamic_pointer_cast<DataModel>(GetParent()) : GetParent()->_dataModel;
-        this->_workspace = GetParent()->GetClass() == &Workspace::TYPE ? std::dynamic_pointer_cast<Workspace>(GetParent()) : GetParent()->_workspace;
+        this->_dataModel = GetParent()->GetType() == &DataModel::TYPE ? std::dynamic_pointer_cast<DataModel>(GetParent()) : GetParent()->_dataModel;
+        this->_workspace = GetParent()->GetType() == &Workspace::TYPE ? std::dynamic_pointer_cast<Workspace>(GetParent()) : GetParent()->_workspace;
     } else {
         this->_dataModel = {};
         this->_workspace = {};
@@ -132,7 +132,7 @@ void Instance::Destroy() {
 }
 
 bool Instance::IsA(std::string className) {
-    const InstanceType* cur = GetClass();
+    const InstanceType* cur = GetType();
     while (cur && cur->className != className) { cur = cur->super; }
     return cur != nullptr;
 }
@@ -203,9 +203,9 @@ result<Variant, MemberNotFound> Instance::InternalGetPropertyValue(std::string n
     } else if (name == "Parent") {
         return Variant(InstanceRef(this->parent));
     } else if (name == "ClassName") {
-        return Variant(GetClass()->className);
+        return Variant(GetType()->className);
     }
-    return MemberNotFound(GetClass()->className, name);
+    return MemberNotFound(GetType()->className, name);
 }
 
 result<PropertyMeta, MemberNotFound> Instance::InternalGetPropertyMeta(std::string name) {
@@ -216,7 +216,7 @@ result<PropertyMeta, MemberNotFound> Instance::InternalGetPropertyMeta(std::stri
     } else if (name == "ClassName") {
         return PropertyMeta { &STRING_TYPE, PROP_NOSAVE | PROP_READONLY };
     }
-    return MemberNotFound(GetClass()->className, name);
+    return MemberNotFound(GetType()->className, name);
 }
 
 fallible<MemberNotFound, AssignToReadOnlyMember> Instance::InternalSetPropertyValue(std::string name, Variant value) {
@@ -226,9 +226,9 @@ fallible<MemberNotFound, AssignToReadOnlyMember> Instance::InternalSetPropertyVa
         std::weak_ptr<Instance> ref = value.get<InstanceRef>();
         SetParent(ref.expired() ? nullptr : ref.lock());
     } else if (name == "ClassName") {
-        return AssignToReadOnlyMember(GetClass()->className, name);
+        return AssignToReadOnlyMember(GetType()->className, name);
     } else {
-        return MemberNotFound(GetClass()->className, name);
+        return MemberNotFound(GetType()->className, name);
     }
     return {};
 }
@@ -262,7 +262,7 @@ std::vector<std::string> Instance::GetProperties() {
 void Instance::Serialize(pugi::xml_node parent, RefStateSerialize state) {
     if (state == nullptr) state = std::make_shared<__RefStateSerialize>();
     pugi::xml_node node = parent.append_child("Item");
-    node.append_attribute("class").set_value(this->GetClass()->className);
+    node.append_attribute("class").set_value(this->GetType()->className);
 
     // Add properties
     pugi::xml_node propertiesNode = node.append_child("Properties");
@@ -339,7 +339,7 @@ result<std::shared_ptr<Instance>, NoSuchInstance> Instance::Deserialize(pugi::xm
         std::string propertyName = propertyNode.attribute("name").value();
         auto meta_ = object->GetPropertyMeta(propertyName);
         if (!meta_) {
-            Logger::fatalErrorf("Attempt to set unknown property '%s' of %s", propertyName.c_str(), object->GetClass()->className.c_str());
+            Logger::fatalErrorf("Attempt to set unknown property '%s' of %s", propertyName.c_str(), object->GetType()->className.c_str());
             continue;
         }
         auto meta = meta_.expect();
@@ -444,7 +444,7 @@ DescendantsIterator::self_type DescendantsIterator::operator++(int _) {
 
 nullable std::shared_ptr<Instance> Instance::Clone(RefStateClone state) {
     if (state == nullptr) state = std::make_shared<__RefStateClone>();
-    std::shared_ptr<Instance> newInstance = GetClass()->constructor();
+    std::shared_ptr<Instance> newInstance = GetType()->constructor();
 
     // Copy properties
     for (std::string property : GetProperties()) {

core/src/objects/base/service.cpp

@@ -8,8 +8,8 @@ Service::Service(const InstanceType* type) : Instance(type) {}
 
 // Fail if parented to non-datamodel, otherwise lock parent
 void Service::OnParentUpdated(nullable std::shared_ptr<Instance> oldParent, nullable std::shared_ptr<Instance> newParent) {
-    if (!newParent || newParent->GetClass() != &DataModel::TYPE) {
-        Logger::fatalErrorf("Service %s was parented to object of type %s", GetClass()->className.c_str(), newParent ? newParent->GetClass()->className.c_str() : "NULL");
+    if (!newParent || newParent->GetType() != &DataModel::TYPE) {
+        Logger::fatalErrorf("Service %s was parented to object of type %s", GetType()->className.c_str(), newParent ? newParent->GetType()->className.c_str() : "NULL");
         panic();
     }
 

core/src/objects/datamodel.cpp

@@ -184,8 +184,8 @@ std::shared_ptr<DataModel> DataModel::CloneModel() {
         newModel->AddChild(result);
 
         // Special case: Ignore instances parented to DataModel which are not services
-        if (child->GetClass()->flags & INSTANCE_SERVICE) {
-            newModel->services[child->GetClass()->className] = std::dynamic_pointer_cast<Service>(result);
+        if (child->GetType()->flags & INSTANCE_SERVICE) {
+            newModel->services[child->GetType()->className] = std::dynamic_pointer_cast<Service>(result);
         }
     }
 

core/src/objects/joint/jointinstance.cpp

@@ -45,7 +45,7 @@ void JointInstance::Update() {
     oldPart1 = part1;
 
     // Don't build the joint if we're not part of either a workspace or JointsService
-    if ((!GetParent() || GetParent()->GetClass() != &JointsService::TYPE) && !workspace()) return;
+    if ((!GetParent() || GetParent()->GetType() != &JointsService::TYPE) && !workspace()) return;
 
     // If either part is invalid or they are part of separate worlds, fail
     if (part0.expired()

core/src/rendering/renderer.cpp

@@ -373,7 +373,7 @@ void renderAABB() {
 
     // Sort by nearest
     for (std::shared_ptr<Instance> inst : gWorkspace()->GetChildren()) {
-        if (inst->GetClass()->className != "Part") continue;
+        if (inst->GetType()->className != "Part") continue;
         std::shared_ptr<BasePart> part = std::dynamic_pointer_cast<BasePart>(inst);
         glm::mat4 model = CFrame::IDENTITY + part->cframe.Position();
         printf("AABB is supposedly (%f, %f, %f)\n", part->GetAABB().X(), part->GetAABB().Y(), part->GetAABB().Z());
@@ -413,7 +413,7 @@ void renderWireframe() {
 
     // Sort by nearest
     for (std::shared_ptr<Instance> inst : gWorkspace()->GetChildren()) {
-        if (inst->GetClass()->className != "Part") continue;
+        if (inst->GetType()->className != "Part") continue;
         std::shared_ptr<BasePart> part = std::dynamic_pointer_cast<BasePart>(inst);
         glm::mat4 model = part->cframe;
         model = glm::scale(model, (glm::vec3)part->size);
@@ -455,7 +455,7 @@ void renderOutlines() {
 
     std::shared_ptr<Selection> selection = gDataModel->GetService<Selection>();
     for (auto inst : selection->Get()) {
-        if (inst->GetClass() != &BasePart::TYPE) continue;
+        if (inst->GetType() != &BasePart::TYPE) continue;
         std::shared_ptr<BasePart> part = std::dynamic_pointer_cast<BasePart>(inst);
 
         if (first)
@@ -640,7 +640,7 @@ void renderMessages() {
         float textWidth = calcTextWidth(sansSerif, message->text);
 
         // Render hint
-        if (message->GetClass() == &Hint::TYPE) {
+        if (message->GetType() == &Hint::TYPE) {
             drawRect(0, 0, viewportWidth, 20, glm::vec4(0,0,0,1));
             drawText(sansSerif, message->text, (viewportWidth - textWidth) / 2, 0);
         } else {

docs/autogen.md

@@ -62,7 +62,7 @@ It comes with various parameters/flags:
 - `service` - Flag, the instance is a service. Additionally, enable the `not_creatable` flag as well (Adds both `INSTANCE_NOTCREATABLE` and `INSTANCE_SERVICE` flags)
 - `explorer_icon` - Option, string to pass into editor for the icon of the instance in the explorer
 
-A file will be generated in `build/generated/<header>.cpp` with the `TYPE` automatically filled in, as well as an implementation for `GetClass()`
+A file will be generated in `build/generated/<header>.cpp` with the `TYPE` automatically filled in, as well as an implementation for `GetType()`
 
 Note that it is also necessary to add `AUTOGEN_PREAMBLE` to the top of your class definition, to make sure that various functions for properties, etc. are
 declared such that they can later be defined in the generated source file.