sdformat_parser_interface.h

/*
* sdformat-editor
* Copyright 2025 sdformat-editor
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*     http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* Developer: Zaid Duraid, Ean Wheeler, Evan Vokey
*/
 
#ifndef SDFORMAT_EDITOR_PARSER_INTERFACE_HH_
#define SDFORMAT_EDITOR_PARSER_INTERFACE_HH_
 
#include <iostream>
 
// SDFormat dependencies
#include <sdf/sdf.hh>
 
#include <interfaces/model_viewer_interface.h>
 
class SDFormatParserI
{
    public: virtual void Initialize(const std::string file_path, bool &success) = 0;
 
    public: virtual sdf::SDFPtr GetSDFElement() = 0;
 
    public: struct Mentions
    {
        std::vector<sdf::ElementPtr> elements;
        std::vector<sdf::ParamPtr> attributes;
    };
 
    public: virtual std::vector<sdf::ElementPtr> LookupElementsByAttributeType(const std::string& attribute_type) = 0;
 
    public: virtual std::vector<sdf::ElementPtr> LookupElementsByAttributeTypeAndValue(const std::string& attribute_type, const std::string& attribute_value) = 0;
 
    public: virtual std::vector<sdf::ElementPtr> LookupElementsByType(const std::string& type) = 0;
 
    public: virtual Mentions FindMentions(std::string key) = 0;
    
    public: virtual Mentions FindMentions(std::string key, sdf::ElementPtr element_to_exclude) = 0;
 
    public: virtual Mentions FindMentions(std::string key, sdf::ParamPtr attribute_to_exclude) = 0;
 
    public: virtual Mentions FindMentions(std::string key, sdf::ElementPtr element_to_exclude, sdf::ParamPtr attribute_to_exclude) = 0;
 
    public: virtual std::string GetSDFTreePathToElement(sdf::ElementPtr element) = 0; 
 
    public: virtual std::pair<std::vector<ModelViewerI::ModelInfo>, std::vector<ModelViewerI::PresetModelInfo>> GetModelsFromSDFTree(bool render_collisions = false) = 0;
 
};
 
#endif