StudioImageCaptureBuilder Class

class NXOpen.Display.StudioImageCaptureBuilder

Bases: NXOpen.Builder

Represents a NXOpen.Display.StudioImageCaptureBuilder

This class is restricted to being called from a program running during an Interactive NX session. If run from a non-interactive session it will return None.

To create a new instance of this class, use NXOpen.ViewCollection.CreateStudioImageCaptureBuilder()

Default values.

Property	Value
AASamplesEnum	Sam0X
DpiEnum	Dpi72
DrawingSizeEnum	Isoa4
OrientEnum	Landscape
UnitsEnum	Pixels

New in version NX6.0.4.

Properties

Property	Description
AASamplesEnum	Returns or sets the antialiasing samples enum
DpiEnum	Returns or sets the dpi enum
DrawingSizeEnum	Returns or sets the drawing size enum
NativeFileBrowser	Returns or sets the native file browser for image type to produce
OrientEnum	Returns or sets the orient enum
Tag	Returns the Tag for this object.
UnitsEnum	Returns or sets the units enum

Methods

Method	Description
Commit	Commits any edits that have been applied to the builder.
Destroy	Deletes the builder, and cleans up any objects created by the builder.
GetCommittedObjects	For builders that create more than one object, this method returns the objects that are created by commit.
GetImageDimensionsDouble	Gets the double image dimensions, height and width
GetImageDimensionsInteger	Gets the integer image dimensions, height and width
GetObject	Returns the object currently being edited by this builder.
SetImageDimensionsDouble	Sets the double image dimensions, height and width
SetImageDimensionsInteger	Sets the integer image dimensions, height and width
ShowResults	Updates the model to reflect the result of an edit to the model for all builders that support showing results.
Validate	Validate whether the inputs to the component are sufficient for commit to be called.

Enumerations

StudioImageCaptureBuilderAASamplesEnumType Enumeration	Provide the following anti-aliasing sample size for off screen image capture
StudioImageCaptureBuilderDPIEnumType Enumeration	Provide the following screen capture resolutions in dots per inch
StudioImageCaptureBuilderDrawingSizeEnumType Enumeration	Provide the following standard Drawing sizes
StudioImageCaptureBuilderOrientEnumType Enumeration	Provide the following options to image orientation
StudioImageCaptureBuilderUnitsEnumType Enumeration	Provide the following resolution unit options to screen capture

Property Detail

AASamplesEnum

StudioImageCaptureBuilder.AASamplesEnum

Returns or sets the antialiasing samples enum

-------------------------------------

Getter Method

Signature AASamplesEnum

Returns: Return type:NXOpen.Display.StudioImageCaptureBuilderAASamplesEnumType

New in version NX6.0.4.

License requirements: None.

-------------------------------------

Setter Method

Signature AASamplesEnum

Parameters:aASamplesEnum (NXOpen.Display.StudioImageCaptureBuilderAASamplesEnumType) –

New in version NX6.0.4.

License requirements: None.

DpiEnum

StudioImageCaptureBuilder.DpiEnum

Returns or sets the dpi enum

-------------------------------------

Getter Method

Signature DpiEnum

Returns: Return type:NXOpen.Display.StudioImageCaptureBuilderDPIEnumType

New in version NX6.0.4.

License requirements: None.

-------------------------------------

Setter Method

Signature DpiEnum

Parameters:dpiEnum (NXOpen.Display.StudioImageCaptureBuilderDPIEnumType) –

New in version NX6.0.4.

License requirements: None.

DrawingSizeEnum

StudioImageCaptureBuilder.DrawingSizeEnum

Returns or sets the drawing size enum

-------------------------------------

Getter Method

Signature DrawingSizeEnum

Returns: Return type:NXOpen.Display.StudioImageCaptureBuilderDrawingSizeEnumType

New in version NX6.0.4.

License requirements: None.

-------------------------------------

Setter Method

Signature DrawingSizeEnum

Parameters:drawingSizeEnum (NXOpen.Display.StudioImageCaptureBuilderDrawingSizeEnumType) –

New in version NX6.0.4.

License requirements: None.

NativeFileBrowser

StudioImageCaptureBuilder.NativeFileBrowser

Returns or sets the native file browser for image type to produce

-------------------------------------

Getter Method

Signature NativeFileBrowser

Returns: Return type:str

New in version NX6.0.4.

License requirements: None.

-------------------------------------

Setter Method

Signature NativeFileBrowser

Parameters:filename (str) –

New in version NX6.0.4.

License requirements: None.

OrientEnum

StudioImageCaptureBuilder.OrientEnum

Returns or sets the orient enum

-------------------------------------

Getter Method

Signature OrientEnum

Returns: Return type:NXOpen.Display.StudioImageCaptureBuilderOrientEnumType

New in version NX6.0.4.

License requirements: None.

-------------------------------------

Setter Method

Signature OrientEnum

Parameters:orientEnum (NXOpen.Display.StudioImageCaptureBuilderOrientEnumType) –

New in version NX6.0.4.

License requirements: None.

UnitsEnum

StudioImageCaptureBuilder.UnitsEnum

Returns or sets the units enum

-------------------------------------

Getter Method

Signature UnitsEnum

Returns: Return type:NXOpen.Display.StudioImageCaptureBuilderUnitsEnumType

New in version NX6.0.4.

License requirements: None.

-------------------------------------

Setter Method

Signature UnitsEnum

Parameters:unitsEnum (NXOpen.Display.StudioImageCaptureBuilderUnitsEnumType) –

New in version NX6.0.4.

License requirements: None.

Method Detail

GetImageDimensionsDouble

StudioImageCaptureBuilder.GetImageDimensionsDouble

Gets the double image dimensions, height and width

Signature GetImageDimensionsDouble()

Returns:array of 2 doubles Return type:list of float

New in version NX6.0.4.

License requirements: None.

GetImageDimensionsInteger

StudioImageCaptureBuilder.GetImageDimensionsInteger

Gets the integer image dimensions, height and width

Signature GetImageDimensionsInteger()

Returns:array of 2 integers Return type:list of int

New in version NX6.0.4.

License requirements: None.

SetImageDimensionsDouble

StudioImageCaptureBuilder.SetImageDimensionsDouble

Sets the double image dimensions, height and width

Signature SetImageDimensionsDouble(imageDimensionsDouble)

Parameters:imageDimensionsDouble (list of float) – array of 2 doubles

New in version NX6.0.4.

License requirements: None.

SetImageDimensionsInteger

StudioImageCaptureBuilder.SetImageDimensionsInteger

Sets the integer image dimensions, height and width

Signature SetImageDimensionsInteger(imageDimensionsInteger)

Parameters:imageDimensionsInteger (list of int) – array of 2 integers

New in version NX6.0.4.

License requirements: None.

Validate

StudioImageCaptureBuilder.Validate

Validate whether the inputs to the component are sufficient for commit to be called.

If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.

Signature Validate()

Returns:Was self validation successful Return type:bool

New in version NX3.0.1.

License requirements: None.