Renderer / RIP. More...

Public Member Functions
	AOI_SoftProofRenderer (AOI_Document *document)

	~AOI_SoftProofRenderer ()

bool	Setup (const aur::ACPL::FileSpec &profileFile, const aur::ACPL::FileSpec &cmmFile)

void	AssignInputProfiles (const aur::ACPL::FileSpec &rgbProfile, const aur::ACPL::FileSpec &cmykProfile, const aur::ACPL::FileSpec &grayProfile, int32_t intent)

void	SetupPage ()

uint32_t	GetDocumentChannelCount ()

const char *	GetDocumentChannelName (uint32_t index)

void	UpdateRenderer (uint32_t width, uint32_t height)

bool	Render (const aur::ACPL::FileSpec &outputPath, const char *thumbnailType, int32_t x, int32_t y, int32_t width, int32_t height, uint32_t quality=100, uint64_t visiblePlates=UINT64_MAX)

bool	RenderTiles (const TileSettings &tileSettings, const aur::ACPL::FileSpec &outputPath, int16_t channelIndex, const aur::ACPL::UString &multichannelRender)

Detailed Description

Renderer / RIP.

Definition at line 24 of file AOI_SoftProofRenderer.h.

Constructor & Destructor Documentation

◆ AOI_SoftProofRenderer()

AOI_SoftProofRenderer::AOI_SoftProofRenderer ( AOI_Document * document )

Constructs a new AOI_SoftProofRenderer. This renderer can be used to create thumbnails or tiles in jpeg or png format.

Parameters

document AOI_Document object used by this thread.

Definition at line 303 of file AOI_SoftProofRenderer.cpp.

◆ ~AOI_SoftProofRenderer()

AOI_SoftProofRenderer::~AOI_SoftProofRenderer ( )

Releases the resources and memory used by the renderer

Definition at line 1201 of file AOI_SoftProofRenderer.cpp.

Member Function Documentation

◆ AssignInputProfiles()

void AOI_SoftProofRenderer::AssignInputProfiles	(	const aur::ACPL::FileSpec &	rgbProfile,
		const aur::ACPL::FileSpec &	cmykProfile,
		const aur::ACPL::FileSpec &	grayProfile,
		int32_t	intent )

Assign Input profiles to the document

Parameters

rgbProfile	Path to the RGB profile that will be assigned.
cmykProfile	Path to the CMYK profile that will be assigned.
grayProfile	Path to the GRAY profile that will be assigned.
intent	Rendering intent that will be used.

Returns: True if the method is successfully executed otherwise false.

Definition at line 888 of file AOI_SoftProofRenderer.cpp.

◆ GetDocumentChannelCount()

uint32_t AOI_SoftProofRenderer::GetDocumentChannelCount ( )

Returns the document renderer channels count

Returns: The name of the channel with the specified index

Definition at line 497 of file AOI_SoftProofRenderer.cpp.

◆ GetDocumentChannelName()

const char * AOI_SoftProofRenderer::GetDocumentChannelName ( uint32_t index )

Returns the document renderer channel name with the specified index

Parameters

index The channel name index to return

Returns: The name of the channel with the specified index

Definition at line 487 of file AOI_SoftProofRenderer.cpp.

◆ Render()

bool AOI_SoftProofRenderer::Render	(	const aur::ACPL::FileSpec &	outputPath,
		const char *	thumbnailType,
		int32_t	x,
		int32_t	y,
		int32_t	width,
		int32_t	height,
		uint32_t	quality = 100,
		uint64_t	visiblePlates = UINT64_MAX )

Renders the document using the specified rectangle, and the profiles used in setup method. It also saves the output in the specified format to a file.

Parameters

outputPath	The path where the rendering result will be saved.
thumbnailType	jpg or png
x	X coordinate of the Top-Left corner of the desired tile
y	Y coordinate of the Top-Left corner of the desired tile
width	The width of the desired tile
height	The height of the desired tile
quality	Quality factor when saving as JPEG.
visiblePlates	The mask that describes which channels should be included in the output

Returns: TRUE if the method is successfully executed otherwise false.

Definition at line 396 of file AOI_SoftProofRenderer.cpp.

◆ RenderTiles()

bool AOI_SoftProofRenderer::RenderTiles	(	const TileSettings &	tileSettings,
		const aur::ACPL::FileSpec &	outputPath,
		int16_t	channelIndex,
		const aur::ACPL::UString &	multichannelRender )

Renders the document creating tiles by using the specified TileSettings, and also a 1:1 jpg preview of the document. It uses a multi-band algorithm that creates multiple bands based on the document height and the maximum memory of memory specified. It also renders the original document at double width/height and then downsampling it by two, increasing the quality of the output preview.

Parameters

tileSettings	The settings containing information about the rendering and creation of document tiles.
outputPath	The output folder where the tiles and the preview will be saved.
channelIndex	The channel index for for which the tiles and the preview will be created. In case the output must contain all channels then -1 must be passed.
multichannelRender	Name of the cache file where rendering information is saved to be used later on when channel separation processing is requested. Optional.

Returns: True if the method is successfully executed otherwise false.

Definition at line 948 of file AOI_SoftProofRenderer.cpp.

◆ Setup()

bool AOI_SoftProofRenderer::Setup	(	const aur::ACPL::FileSpec &	profileFile,
		const aur::ACPL::FileSpec &	cmmFile )

Setup the document using the specified profile file and CMM file For the documents with embedded profiles the routine will use the embedded profile for setting up the renderer.

Parameters

referenceProfile	The path to the profile file used to setup the document renderer.
outputProfile	The path to the PMM file used to setup the document renderer.

Returns: TRUE if the method is successfully executed otherwise false.

Definition at line 323 of file AOI_SoftProofRenderer.cpp.

◆ SetupPage()

void AOI_SoftProofRenderer::SetupPage ( )

Checks whether the current page has an embedded profile and if so applies it to the renderer otherwise uses the reference profile.

Definition at line 356 of file AOI_SoftProofRenderer.cpp.

◆ UpdateRenderer()

void AOI_SoftProofRenderer::UpdateRenderer	(	uint32_t	width,
		uint32_t	height )

Updates the renderer for rendering at specified dimensions

Parameters

width	The rendering width
height	The rendering height

Definition at line 472 of file AOI_SoftProofRenderer.cpp.

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

C:/Environments/desktop/Source/PDFEngine/OpenAPI/AOI_SoftProofRenderer.h
C:/Environments/desktop/Source/PDFEngine/OpenAPI/AOI_SoftProofRenderer.cpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ AOI_SoftProofRenderer()

◆ ~AOI_SoftProofRenderer()

Member Function Documentation

◆ AssignInputProfiles()

◆ GetDocumentChannelCount()

◆ GetDocumentChannelName()

◆ Render()

◆ RenderTiles()

◆ Setup()

◆ SetupPage()

◆ UpdateRenderer()