VCOM:VectorWorks:Imaging:ICompressedImage

Description

namespace VectorWorks::Imaging

..put some descriptoin in here...

Interface

// ----------------------------------------------------------------------------------------------------
// {F1620FEA-3AA4-4E0F-A7FF-715958BE72BD}
static const VWIID IID_CompressedImage = { 0xF1620FEA, 0x3AA4, 0x4E0F, { 0xA7, 0xFF, 0x71, 0x59, 0x58, 0xBE, 0x72, 0xBD } };

class DYNAMIC_ATTRIBUTE ICompressedImage : public IVWUnknown
{
public:
	virtual bool VCOM_CALLTYPE IsInitialized() = 0;

	virtual VCOMError VCOM_CALLTYPE	CreateFromStream(const ImageStream& inImageStream) = 0;
	virtual VCOMError VCOM_CALLTYPE	CreateFromFile(Filing::IFileIdentifier* inpFileID) = 0;
	virtual VCOMError VCOM_CALLTYPE	CreateFromRAWImage(IRawImage* inpIRawImage, CompressionType inCompressionType) = 0;
	virtual VCOMError VCOM_CALLTYPE	CreateFromRAWImageEx(IRawImage* inpIRawImage, const TXString& inFormatIDStr, double inQuality) = 0;
	virtual VCOMError VCOM_CALLTYPE CreateFromObject(MCObjectHandle inImageObj) = 0;
	virtual VCOMError VCOM_CALLTYPE	CreateFromDrawPad(IDrawPad* inpIDrawPad, CompressionType inCompressionType) = 0;

	virtual VCOMError VCOM_CALLTYPE	GetImageStream(ImageStream& outImageStream) = 0;
	virtual VCOMError VCOM_CALLTYPE	GetBufferPtr(void** outBufferPtr) = 0;
	virtual VCOMError VCOM_CALLTYPE	GetBufferSize(Uint32& outBufferSize) = 0;
	virtual VCOMError VCOM_CALLTYPE	GetCompressionType(CompressionType& outComp) = 0;
	virtual VCOMError VCOM_CALLTYPE	GetCompressedImageDesc(CompressedImageDesc& outImageDesc) = 0;

	virtual VCOMError VCOM_CALLTYPE	Save(Filing::IFileIdentifier* inpFileID) = 0;

	virtual VCOMError VCOM_CALLTYPE CreateBitmapObject(MCObjectHandle& outhObj) = 0;
	virtual VCOMError VCOM_CALLTYPE CreateImageObject(MCObjectHandle& outhObj) = 0;

	virtual VCOMError VCOM_CALLTYPE GetImageFormatIDForType(EImageFormatType inType, TXString& outFormatIDStr) = 0;
	virtual VCOMError VCOM_CALLTYPE GetImageFormatTypeForID(const TXString& inFormatIDStr, EImageFormatType& outType) = 0;

	virtual VCOMError VCOM_CALLTYPE GetImageFormatID_SupportedList(TXStringArray& outFormatIDStrList, bool inbForImportOrExport) = 0;

	virtual VCOMError VCOM_CALLTYPE GetImageFormatID_LocalizedName(const TXString& inFormatIDStr, TXString& outLocName) = 0;
	virtual VCOMError VCOM_CALLTYPE GetImageFormatID_FileExtensions(const TXString& inFormatIDStr, TXStringArray& outExtensions) = 0;
	virtual VCOMError VCOM_CALLTYPE GetImageFormatID_SupportsResolution(const TXString& inFormatIDStr, bool& outbSupportsResolution) = 0;

	virtual VCOMError VCOM_CALLTYPE GetImageFormatID_EncoderCapabilities(const TXString& inFormatIDStr, TImageEncoderCapabilities& outCaps) = 0;
};

Members

IsInitialized
CreateFromStream
CreateFromFile
CreateFromRAWImage
CreateFromRAWImageEx
CreateFromObject
CreateFromDrawPad
GetImageStream
GetBufferPtr
GetBufferSize
GetCompressionType
GetCompressedImageDesc
Save
CreateBitmapObject
CreateImageObject
GetImageFormatIDForType
GetImageFormatTypeForID
GetImageFormatID_SupportedList
GetImageFormatID_LocalizedName
GetImageFormatID_FileExtensions
GetImageFormatID_SupportsResolution
GetImageFormatID_EncoderCapabilities

Remarks

There is predefined type for smart VCOM pointer VCOMPtr to ICompressedImage interface:

typedef VCOMPtr<ICompressedImage>  ICompressedImagePtr;

Version

Available from: Vectorworks 2015

See Also

VCOM:VCOMPtr

[[VCOM:VCOMPtr]]