public interface Background extends Builder
Background
Background defines how background pixels are displayed. The background
resides on a virtual plane at the back of a view. This background is used
for display in Studio rendering style and High Quality Images.
ViewCollection.createBackground(nxopen.View, boolean)
Modifier and Type | Interface and Description |
---|---|
static class |
Background.BackgroundDomeType
dome types
|
static class |
Background.CategoryType
background 2D3D types
|
static class |
Background.Type
background types
|
Modifier and Type | Method and Description |
---|---|
Background.CategoryType |
backgroundCategory()
Returns the background 2D or 3D type
License requirements: None. |
Background.Type |
backgroundType()
Returns the background type
License requirements: None. |
Image |
domeImage()
Returns the dome background's image builder
License requirements: None. |
String |
domeImageFilename()
Returns the background's dome image filename
License requirements: None. |
Point |
domeOrigin()
Returns the origin
License requirements: None. |
double |
domeSize()
Returns the dome size
License requirements: None. |
Background.BackgroundDomeType |
domeType()
Returns the dome type
License requirements: None. |
double[] |
getBottomColor()
Returns the bottom color
License requirements: None. |
double[] |
getTopColor()
Returns the top color
License requirements: None. |
Image |
image()
Returns the background's image builder
License requirements: None. |
String |
imageFilename()
Returns the background's image filename
License requirements: None. |
double |
imageHorizon()
Returns the dome image horizon
License requirements: None. |
double |
imageRotation()
Returns the image rotation angle (in degrees)
License requirements: None. |
Direction |
imageUpVector()
Returns the image up vector direction, relative to the absolute coordinate system
License requirements: None. |
void |
setBackgroundCategory(Background.CategoryType backgroundCategoryType)
License requirements: None. |
void |
setBackgroundType(Background.Type backgroundType)
License requirements: None. |
void |
setBottomColor(double[] bottomColor)
Sets the bottom color
License requirements: None. |
void |
setDomeImage(Image domeImageBuilder)
License requirements: None. |
void |
setDomeImageFilename(String domeImageFileName)
License requirements: None. |
void |
setDomeOrigin(Point origin)
License requirements: None. |
void |
setDomeSize(double domeSize)
License requirements: None. |
void |
setDomeType(Background.BackgroundDomeType domeType)
License requirements: None. |
void |
setImage(Image imageBuilder)
License requirements: None. |
void |
setImageFilename(String imageFileName)
License requirements: None. |
void |
setImageHorizon(double imageHorizon)
License requirements: None. |
void |
setImageRotation(double imageRotation)
License requirements: None. |
void |
setImageUpVector(Direction imageUpVector)
License requirements: None. |
void |
setTopColor(double[] topColor)
Sets the top color
License requirements: None. |
void |
setUseStageSizeAndOrientation(boolean StageSizeAndOrientation)
License requirements: None. |
boolean |
useStageSizeAndOrientation()
Returns whether to use stage Size and Orientation
License requirements: None. |
commit, destroy, getCommittedObjects, getObject, showResults
printTestData, printTestData, tag, tagValue
validate
Background.CategoryType backgroundCategory() throws NXException, RemoteException
NXException
RemoteException
void setBackgroundCategory(Background.CategoryType backgroundCategoryType) throws NXException, RemoteException
backgroundCategoryType
- NXException
RemoteException
Background.Type backgroundType() throws NXException, RemoteException
NXException
RemoteException
void setBackgroundType(Background.Type backgroundType) throws NXException, RemoteException
backgroundType
- NXException
RemoteException
double[] getBottomColor() throws NXException, RemoteException
NXException
RemoteException
void setBottomColor(double[] bottomColor) throws NXException, RemoteException
bottomColor
- Array of 3 rgb values, each between 0 and 1NXException
RemoteException
double[] getTopColor() throws NXException, RemoteException
NXException
RemoteException
void setTopColor(double[] topColor) throws NXException, RemoteException
topColor
- Array of 3 rgb values, each between 0 and 1NXException
RemoteException
Image image() throws NXException, RemoteException
NXException
RemoteException
void setImage(Image imageBuilder) throws NXException, RemoteException
imageBuilder
- NXException
RemoteException
String imageFilename() throws NXException, RemoteException
NXException
RemoteException
void setImageFilename(String imageFileName) throws NXException, RemoteException
imageFileName
- NXException
RemoteException
boolean useStageSizeAndOrientation() throws NXException, RemoteException
NXException
RemoteException
void setUseStageSizeAndOrientation(boolean StageSizeAndOrientation) throws NXException, RemoteException
StageSizeAndOrientation
- NXException
RemoteException
double domeSize() throws NXException, RemoteException
NXException
RemoteException
void setDomeSize(double domeSize) throws NXException, RemoteException
domeSize
- NXException
RemoteException
Point domeOrigin() throws NXException, RemoteException
NXException
RemoteException
void setDomeOrigin(Point origin) throws NXException, RemoteException
origin
- NXException
RemoteException
double imageHorizon() throws NXException, RemoteException
NXException
RemoteException
void setImageHorizon(double imageHorizon) throws NXException, RemoteException
imageHorizon
- NXException
RemoteException
double imageRotation() throws NXException, RemoteException
NXException
RemoteException
void setImageRotation(double imageRotation) throws NXException, RemoteException
imageRotation
- NXException
RemoteException
Direction imageUpVector() throws NXException, RemoteException
NXException
RemoteException
void setImageUpVector(Direction imageUpVector) throws NXException, RemoteException
imageUpVector
- NXException
RemoteException
Image domeImage() throws NXException, RemoteException
NXException
RemoteException
void setDomeImage(Image domeImageBuilder) throws NXException, RemoteException
domeImageBuilder
- NXException
RemoteException
String domeImageFilename() throws NXException, RemoteException
NXException
RemoteException
void setDomeImageFilename(String domeImageFileName) throws NXException, RemoteException
domeImageFileName
- NXException
RemoteException
Background.BackgroundDomeType domeType() throws NXException, RemoteException
NXException
RemoteException
void setDomeType(Background.BackgroundDomeType domeType) throws NXException, RemoteException
domeType
- NXException
RemoteException
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.