NXOpen .NET Reference
12.0.0
|
Represents a NXOpen.Display.Background Background defines how background pixels are displayed. More...
Public Types | |
enum | CategoryType { Flat, Dome } |
background 2D3D types More... | |
enum | Type { Plain, Graduated, Image, HemiDome } |
background types More... | |
enum | BackgroundDomeType { Finite, Infinite } |
dome types More... | |
Public Member Functions | |
unsafe double[] | GetBottomColor () |
Returns the bottom color More... | |
unsafe void | SetBottomColor (double[] bottomColor) |
Sets the bottom color More... | |
unsafe double[] | GetTopColor () |
Returns the top color More... | |
unsafe void | SetTopColor (double[] topColor) |
Sets the top color More... | |
Public Member Functions inherited from NXOpen.Builder | |
unsafe NXOpen.NXObject | Commit () |
Commits any edits that have been applied to the builder. More... | |
unsafe void | Destroy () |
Deletes the builder, and cleans up any objects created by the builder. More... | |
unsafe NXOpen.NXObject[] | GetCommittedObjects () |
For builders that create more than one object, this method returns the objects that are created by commit. More... | |
unsafe NXOpen.NXObject | GetObject () |
Returns the object currently being edited by this builder. More... | |
unsafe void | ShowResults () |
Updates the model to reflect the result of an edit to the model for all builders that support showing results. More... | |
unsafe bool | Validate () |
Validate whether the inputs to the component are sufficient for commit to be called. More... | |
Properties | |
unsafe NXOpen.Display.Background.CategoryType | BackgroundCategory [get, set] |
Returns or sets the background 2D or 3D type More... | |
unsafe NXOpen.Display.Background.Type | BackgroundType [get, set] |
Returns or sets the background type More... | |
unsafe NXOpen.Display.Image | DomeImage [get, set] |
Returns or sets the dome background's image builder More... | |
unsafe string | DomeImageFilename [get, set] |
Returns or sets the background's dome image filename More... | |
unsafe NXOpen.Point | DomeOrigin [get, set] |
Returns or sets the origin More... | |
unsafe double | DomeSize [get, set] |
Returns or sets the dome size More... | |
unsafe NXOpen.Display.Background.BackgroundDomeType | DomeType [get, set] |
Returns or sets the dome type More... | |
unsafe NXOpen.Display.Image | Image [get, set] |
Returns or sets the background's image builder More... | |
unsafe string | ImageFilename [get, set] |
Returns or sets the background's image filename More... | |
unsafe double | ImageHorizon [get, set] |
Returns or sets the dome image horizon More... | |
unsafe double | ImageRotation [get, set] |
Returns or sets the image rotation angle (in degrees) More... | |
unsafe NXOpen.Direction | ImageUpVector [get, set] |
Returns or sets the image up vector direction, relative to the absolute coordinate system More... | |
unsafe bool | UseStageSizeAndOrientation [get, set] |
Returns or sets whether to use stage Size and Orientation More... | |
Represents a NXOpen.Display.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.
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 a null reference (Nothing in Visual Basic).
To create a new instance of this class, use NXOpen.ViewCollection.CreateBackground
Created in NX5.0.0
unsafe double [] NXOpen.Display.Background.GetBottomColor | ( | ) |
Returns the bottom color
Created in NX5.0.0
License requirements: None.
unsafe double [] NXOpen.Display.Background.GetTopColor | ( | ) |
Returns the top color
Created in NX5.0.0
License requirements: None.
unsafe void NXOpen.Display.Background.SetBottomColor | ( | double[] | bottomColor | ) |
Sets the bottom color
Created in NX5.0.0
License requirements: None.
bottomColor | Array of 3 rgb values, each between 0 and 1 |
unsafe void NXOpen.Display.Background.SetTopColor | ( | double[] | topColor | ) |
Sets the top color
Created in NX5.0.0
License requirements: None.
topColor | Array of 3 rgb values, each between 0 and 1 |
|
getset |
Returns or sets the background 2D or 3D type
Created in NX10.0.2
License requirements to get this property: None.
License requirements to set this property: None.
|
getset |
Returns or sets the background type
Created in NX5.0.0
License requirements to get this property: None.
License requirements to set this property: None.
|
getset |
Returns or sets the dome background's image builder
Created in NX8.5.0
License requirements to get this property: None.
License requirements to set this property: None.
|
getset |
Returns or sets the background's dome image filename
Created in NX8.5.0
License requirements to get this property: None.
License requirements to set this property: None.
|
getset |
Returns or sets the origin
Created in NX8.5.0
License requirements to get this property: None.
License requirements to set this property: None.
|
getset |
Returns or sets the dome size
Created in NX8.5.0
License requirements to get this property: None.
License requirements to set this property: None.
|
getset |
Returns or sets the dome type
Created in NX12.0.0
License requirements to get this property: None.
License requirements to set this property: None.
|
getset |
Returns or sets the background's image builder
Created in NX5.0.0
License requirements to get this property: None.
License requirements to set this property: None.
|
getset |
Returns or sets the background's image filename
Created in NX5.0.0
License requirements to get this property: None.
License requirements to set this property: None.
|
getset |
Returns or sets the dome image horizon
Created in NX8.5.0
License requirements to get this property: None.
License requirements to set this property: None.
|
getset |
Returns or sets the image rotation angle (in degrees)
Created in NX8.5.0
License requirements to get this property: None.
License requirements to set this property: None.
|
getset |
Returns or sets the image up vector direction, relative to the absolute coordinate system
Created in NX8.5.0
License requirements to get this property: None.
License requirements to set this property: None.
|
getset |
Returns or sets whether to use stage Size and Orientation
Created in NX8.5.0
License requirements to get this property: None.
License requirements to set this property: None.