hdicorePlacedArt.h

Go to the documentation of this file.

 
#ifndef __HDI_CORE_PLACED_ART__
#define __HDI_CORE_PLACED_ART__
 
#if defined(HDI_CORE_AIP_MODE)
 
#include "hdicoreArtboardRect.h"
#include "hdicoreTransformMatrix.h"
 
namespace hdi
{
    namespace core
    {
        class Art;
    
        class PlacedArt
        {
            public:
                enum PlacedType
                {
                    PlacedTypeUnknown   = 0,
                    PlacedTypeEPS       = 10,
                    PlacedTypeOther     = 20
                };
                
                enum PlaceMethod
                {
                    PlaceMethodUnknown      = 0,
                    
                    // Preserve original dimensions regardless of bounding box size and transformations
                    PlaceMethodAsIs         = 10,
                    
                    // Fill bounding box while preserving proportions. Can overlap edges in one dimension.
                    PlaceMethodFill         = 20,
                    
                    // Fit fully inside bounding box while preserving proportions
                    PlaceMethodFit          = 30,
                    
                    // Fit to bounding box; replaced file preserves bounds but not proportions
                    PlaceMethodConform      = 40,
                    
                    // Fit to bounding box; replaced file preserves transformations and tries to preserve size
                    PlaceMethodReconform    = 50
                };
            
                enum PlaceMode
                {
                    // If the file can be read, it's simply placed
                    PlaceModeVanilla                = 0,
                    
                    // Consult selection for whether to place or replace. If exactly one placed object is selected, show
                    // "File.Place" dialog to query user on whether to simply place the new art, or use it to replace
                    // the selection.
                    PlaceModeQueryReplace           = 10,
                    
                    // Replaces the existing art
                    PlaceModeForceReplace           = 20,
                    
                    // Replace placed art with its parsed contents
                    PlaceModeUnlinkPlaced           = 30,
                    
                    // Unsupported by this library
//                  PlaceModeCreateNewArt           = 40,
                    
                    // Like PlaceModeForceReplace, but validates the given file first
                    PlaceModeForceReplaceValidate   = 50,
                    
                    // Replace placed art with its parsed contents, querying user for parameters
                    PlaceModeQueryUnlinkPlaced      = 60
                };
            
                ~PlacedArt();
            
                static bool Create(
                    const PlaceMode mode_,
                    const std::string& path_,
                    const bool link_,
                    core::Art* const oldArt_,
                    core::Art& newArt__
                );
                
                PlacedType placedType() const;
                
                std::string filePath() const;
                
                void setFilePath(const std::string& path_);
                
                core::TransformMatrix matrix() const;
                
                void setMatrix(const core::TransformMatrix& matrix_);
                
                core::ArtboardRect bounds() const;
                
                void setBounds(const core::ArtboardRect& b_);
                
                bool options(PlaceMethod& method__, BoundsPinPointType& align__, bool& clip__);
 
                void setOptions(const PlaceMethod method_, const BoundsPinPointType align_, const bool clip_);
 
 
            private:
                // Only Art can construct a new PlacedArt object
                friend class Art;
 
                void* __data;
                
                PlacedArt();
 
                PlacedArt(void* const art_);
            
                PlacedArt(const PlacedArt&);
            
                PlacedArt& operator=(const PlacedArt&);
        };
    }
}
 
#endif
// HDI_CORE_AIP_MODE
 
#endif
// __HDI_CORE_PLACED_ART__