LayoutExportParams Class Reference

The LayoutExportParams JavaScript class. Use a set parameters for the LayoutExport dialog. More...

Public Member Functions
String &	fileDirectory ()
void	setFileDirectory (String &fileDirectory)
String &	filePattern ()
void	setFilePattern (String &filePattern)
String &	fileFormat ()
void	setFileFormat (String &fileFormat)
String &	layoutname ()
void	setLayoutname (String &layoutname)
String &	node ()
void	setNode (String &node)
double	borderScale ()
void	setBorderScale (double borderScale)
double	zoomScale ()
void	setZoomScale (double zoomScale)
bool	exportMultipleFiles ()
void	setExportMultipleFiles (bool b)
bool	keepColorCardVisible ()
void	setKeepColorCardVisible (bool b)
bool	keepLockedElementsVisible ()
void	setKeepLockedElementsVisible (bool b)
String	keepVisible ()
void	setKeepVisible (String k)
bool	exportCameraFrame ()
void	setExportCameraFrame (bool b)
bool	exportAllCameraFrame ()
void	setExportAllCameraFrame (bool b)
bool	exportCameraFrameLabel ()
void	setExportCameraFrameLabel (bool b)
bool	readOverlay ()
void	setReadOverlay (bool b)
bool	readLine ()
void	setReadLine (bool b)
bool	readColor ()
void	setReadColor (bool b)
bool	readUnderlay ()
void	setReadUnderlay (bool b)
int	cameraScope ()
void	setCameraScope (int i)
int	customScopeFirst ()
void	setCustomScopeFirst (int i)
int	customScopeLast ()
void	setCustomScopeLast (int i)
int	frame ()
void	setFrame (int i)
bool	whiteBackground ()
void	setWhiteBackground (bool b)
bool	renderStaticCameraAtSceneRes ()
void	setRenderStaticCameraAtSceneRes (bool b)
String	exportedFrames ()
void	setExportedFrames (String &e)
bool	useCommonSceneBox ()
void	setUseCommonSceneBox (bool commonSceneBox)
double	exportedBoxX1 ()
void	setExportedBoxX1 (double value)
double	exportedBoxX2 ()
void	setExportedBoxX2 (double value)
double	exportedBoxY1 ()
void	setExportedBoxY1 (double value)
double	exportedBoxY2 ()
void	setExportedBoxY2 (double value)
bool	expandRenderAreaToDrawing ()
void	setExpandRenderAreaToDrawing (bool value)

Properties
String	fileDirectory
String	filePattern
String	fileFormat
String	layoutname
String	node
double	borderScale
double	zoomScale
bool	exportMultipleFiles
bool	keepColorCardVisible
bool	keepLockedElementsVisible
String	keepVisible
bool	exportCameraFrame
bool	exportAllCameraFrame
bool	exportCameraFrameLabel
bool	readOverlay
bool	readLine
bool	readColor
bool	readUnderlay
int	cameraScope
int	customScopeFirst
int	customScopeLast
int	frame
bool	whiteBackground
bool	renderStaticCameraAtSceneRes
String	exportedFrames
bool	useCommonSceneBox
double	sceneBox_x1
double	sceneBox_x2
double	sceneBox_y1
double	sceneBox_y2
bool	expandRenderAreaToDrawing

Friends
class	LayoutExport

Detailed Description

The LayoutExportParams JavaScript class. Use a set parameters for the LayoutExport dialog.

Layout Export parameters

 var le = new LayoutExport;
 var params = new LayoutExportParams;

 //  Fetch export values from dialog
 if (le.execDialog(params, true, true, translator.tr("Export Layout Images from Selection")) == false)
  return;

if (le.save(params))
{
  le.saveXli(params);
  MessageLog.trace( le.outputFilePath(params) + " was successfully exported." );
}

Member Function Documentation

borderScale()

double LayoutExportParams::borderScale ( )

inline

cameraScope()

int LayoutExportParams::cameraScope ( )

inline

customScopeFirst()

int LayoutExportParams::customScopeFirst ( )

inline

customScopeLast()

int LayoutExportParams::customScopeLast ( )

inline

expandRenderAreaToDrawing()

bool LayoutExportParams::expandRenderAreaToDrawing ( )

inline

exportAllCameraFrame()

bool LayoutExportParams::exportAllCameraFrame ( )

inline

exportCameraFrame()

bool LayoutExportParams::exportCameraFrame ( )

inline

exportCameraFrameLabel()

bool LayoutExportParams::exportCameraFrameLabel ( )

inline

exportedBoxX1()

double LayoutExportParams::exportedBoxX1

(

)

exportedBoxX2()

double LayoutExportParams::exportedBoxX2

(

)

exportedBoxY1()

double LayoutExportParams::exportedBoxY1

(

)

exportedBoxY2()

double LayoutExportParams::exportedBoxY2

(

)

exportedFrames()

String LayoutExportParams::exportedFrames

(

)

exportMultipleFiles()

bool LayoutExportParams::exportMultipleFiles ( )

inline

fileDirectory()

String& LayoutExportParams::fileDirectory ( )

inline

fileFormat()

String& LayoutExportParams::fileFormat ( )

inline

filePattern()

String& LayoutExportParams::filePattern ( )

inline

frame()

int LayoutExportParams::frame ( )

inline

keepColorCardVisible()

bool LayoutExportParams::keepColorCardVisible ( )

inline

keepLockedElementsVisible()

bool LayoutExportParams::keepLockedElementsVisible ( )

inline

keepVisible()

String LayoutExportParams::keepVisible ( )

inline

layoutname()

String& LayoutExportParams::layoutname ( )

inline

node()

String& LayoutExportParams::node ( )

inline

readColor()

bool LayoutExportParams::readColor ( )

inline

readLine()

bool LayoutExportParams::readLine ( )

inline

readOverlay()

bool LayoutExportParams::readOverlay ( )

inline

readUnderlay()

bool LayoutExportParams::readUnderlay ( )

inline

renderStaticCameraAtSceneRes()

bool LayoutExportParams::renderStaticCameraAtSceneRes ( )

inline

setBorderScale()

void LayoutExportParams::setBorderScale ( double  borderScale )

inline

setCameraScope()

void LayoutExportParams::setCameraScope ( int  i )

inline

setCustomScopeFirst()

void LayoutExportParams::setCustomScopeFirst ( int  i )

inline

setCustomScopeLast()

void LayoutExportParams::setCustomScopeLast ( int  i )

inline

setExpandRenderAreaToDrawing()

void LayoutExportParams::setExpandRenderAreaToDrawing ( bool  value )

inline

setExportAllCameraFrame()

void LayoutExportParams::setExportAllCameraFrame ( bool  b )

inline

setExportCameraFrame()

void LayoutExportParams::setExportCameraFrame ( bool  b )

inline

setExportCameraFrameLabel()

void LayoutExportParams::setExportCameraFrameLabel ( bool  b )

inline

setExportedBoxX1()

void LayoutExportParams::setExportedBoxX1

(

double

value

)

setExportedBoxX2()

void LayoutExportParams::setExportedBoxX2

(

double

value

)

setExportedBoxY1()

void LayoutExportParams::setExportedBoxY1

(

double

value

)

setExportedBoxY2()

void LayoutExportParams::setExportedBoxY2

(

double

value

)

setExportedFrames()

void LayoutExportParams::setExportedFrames

(

String &

e

)

setExportMultipleFiles()

void LayoutExportParams::setExportMultipleFiles ( bool  b )

inline

setFileDirectory()

void LayoutExportParams::setFileDirectory ( String &  fileDirectory )

inline

setFileFormat()

void LayoutExportParams::setFileFormat ( String &  fileFormat )

inline

setFilePattern()

void LayoutExportParams::setFilePattern ( String &  filePattern )

inline

setFrame()

void LayoutExportParams::setFrame ( int  i )

inline

setKeepColorCardVisible()

void LayoutExportParams::setKeepColorCardVisible ( bool  b )

inline

setKeepLockedElementsVisible()

void LayoutExportParams::setKeepLockedElementsVisible ( bool  b )

inline

setKeepVisible()

void LayoutExportParams::setKeepVisible ( String  k )

inline

setLayoutname()

void LayoutExportParams::setLayoutname ( String &  layoutname )

inline

setNode()

void LayoutExportParams::setNode ( String &  node )

inline

setReadColor()

void LayoutExportParams::setReadColor ( bool  b )

inline

setReadLine()

void LayoutExportParams::setReadLine ( bool  b )

inline

setReadOverlay()

void LayoutExportParams::setReadOverlay ( bool  b )

inline

setReadUnderlay()

void LayoutExportParams::setReadUnderlay ( bool  b )

inline

setRenderStaticCameraAtSceneRes()

void LayoutExportParams::setRenderStaticCameraAtSceneRes ( bool  b )

inline

setUseCommonSceneBox()

void LayoutExportParams::setUseCommonSceneBox ( bool  commonSceneBox )

inline

setWhiteBackground()

void LayoutExportParams::setWhiteBackground ( bool  b )

inline

setZoomScale()

void LayoutExportParams::setZoomScale ( double  zoomScale )

inline

useCommonSceneBox()

bool LayoutExportParams::useCommonSceneBox ( )

inline

whiteBackground()

bool LayoutExportParams::whiteBackground ( )

inline

zoomScale()

double LayoutExportParams::zoomScale ( )

inline

Friends And Related Function Documentation

LayoutExport

friend class LayoutExport

friend

Property Documentation

borderScale

double LayoutExportParams::borderScale

readwrite

cameraScope

int LayoutExportParams::cameraScope

readwrite

customScopeFirst

int LayoutExportParams::customScopeFirst

readwrite

customScopeLast

int LayoutExportParams::customScopeLast

readwrite

expandRenderAreaToDrawing

bool LayoutExportParams::expandRenderAreaToDrawing

readwrite

exportAllCameraFrame

bool LayoutExportParams::exportAllCameraFrame

readwrite

exportCameraFrame

bool LayoutExportParams::exportCameraFrame

readwrite

exportCameraFrameLabel

bool LayoutExportParams::exportCameraFrameLabel

readwrite

exportedFrames

String LayoutExportParams::exportedFrames

readwrite

exportMultipleFiles

bool LayoutExportParams::exportMultipleFiles

readwrite

fileDirectory

String LayoutExportParams::fileDirectory

readwrite

fileFormat

String LayoutExportParams::fileFormat

readwrite

filePattern

String LayoutExportParams::filePattern

readwrite

frame

int LayoutExportParams::frame

readwrite

keepColorCardVisible

bool LayoutExportParams::keepColorCardVisible

readwrite

keepLockedElementsVisible

bool LayoutExportParams::keepLockedElementsVisible

readwrite

keepVisible

String LayoutExportParams::keepVisible

readwrite

layoutname

String LayoutExportParams::layoutname

readwrite

node

String LayoutExportParams::node

readwrite

readColor

bool LayoutExportParams::readColor

readwrite

readLine

bool LayoutExportParams::readLine

readwrite

readOverlay

bool LayoutExportParams::readOverlay

readwrite

readUnderlay

bool LayoutExportParams::readUnderlay

readwrite

renderStaticCameraAtSceneRes

bool LayoutExportParams::renderStaticCameraAtSceneRes

readwrite

sceneBox_x1

double LayoutExportParams::sceneBox_x1

readwrite

sceneBox_x2

double LayoutExportParams::sceneBox_x2

readwrite

sceneBox_y1

double LayoutExportParams::sceneBox_y1

readwrite

sceneBox_y2

double LayoutExportParams::sceneBox_y2

readwrite

useCommonSceneBox

bool LayoutExportParams::useCommonSceneBox

readwrite

whiteBackground

bool LayoutExportParams::whiteBackground

readwrite

zoomScale

double LayoutExportParams::zoomScale

readwrite