ReflectionDataBuilder Class¶
-
class
NXOpen.Features.VehicleDesign.
ReflectionDataBuilder
¶ Bases:
NXOpen.Features.FeatureBuilder
Represents a
NXOpen.Features.VehicleDesign.ReflectionData
builderTo create a new instance of this class, use
NXOpen.Features.VehicleDesignCollection.CreateReflectionDataBuilder()
Default values.
Property Value IsReflectData 1 IsReflectTraceCurve 0 IsRefractData 0 IsRefractTraceCurve 0 ReflectAccuracy 20 ReflectMethod DirectReflect RefractionIndex 1.5 Resolution Medium Thickness 5 New in version NX6.0.0.
Properties¶
Property | Description |
---|---|
DashSurface | Returns the reflected object is in the dash surface |
EyePoint | Returns or sets the eye point |
IsReflectData | Returns or sets whether to create reflection data as output or not |
IsReflectTraceCurve | Returns or sets whether to create reflection trace curves as output or not |
IsRefractData | Returns or sets whether to create refraction data as output or not |
IsRefractTraceCurve | Returns or sets whether to create refraction trace curves as output or not |
IsReverseReflectData | Returns or sets whether to create reverse reflection data as output or not |
IsReverseReflectTraceCurve | Returns or sets whether to create reverse reflection trace curves as output or not |
ParentFeatureInternal | Returns or sets whether or not the latest timestamped parent feature of this feature should be made internal |
PatchSolutionFlag | Returns or sets the patch solution flag |
PatchSurfaceFilename | Returns or sets the patch surface filename |
ReflectAccuracy | Returns or sets the customized reflection accuracy, which is the number of dispersed points for the input target objects |
ReflectMethod | Returns or sets the reflection data option type |
ReflectionObject | Returns the reflection object to reflect the input target objects |
RefractionIndex | Returns or sets the refraction index |
Resolution | Returns or sets the resolution type |
ReverseDir | Returns or sets whether the direction of reflection objects is reversed to determine their thickness |
SurroundingPatchSurfaceFilename | Returns or sets the surrounding patch surface filename |
Tag | Returns the Tag for this object. |
TargetObject | Returns the target object to be reflected on the faces and/or planes the target object |
Thickness | Returns or sets the thickness of the reflection objects |
Methods¶
Method | Description |
---|---|
Commit | Commits any edits that have been applied to the builder. |
CommitFeature | Commits the feature parameters and creates the feature |
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. |
GetFeature | Returns the feature currently being edited by this builder. |
GetObject | Returns the object currently being edited by this builder. |
HideInternalParentFeatureAfterEdit | Re-suppress an internal parent feature (a slave feature) after it has been edited. |
SetParentFeatureInternal | Set the parent features which would be internal or slaves to the feature being created or commited |
ShowInternalParentFeatureForEdit | Unsuppress an internal parent feature (a slave feature) so it can be edited. |
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results. |
UnsetParentFeatureInternal | Set the internal parent feature of the feature being edited to external |
Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Enumerations¶
ReflectionDataBuilderReflectMethodType Enumeration | the reflection data option type |
ReflectionDataBuilderResolutionType Enumeration | the resolution type |
Property Detail¶
DashSurface¶
-
ReflectionDataBuilder.
DashSurface
¶ Returns the reflected object is in the dash surface
-------------------------------------
Getter Method
Signature
DashSurface
Returns: Return type: NXOpen.ScCollector
New in version NX11.0.0.
License requirements: None.
EyePoint¶
-
ReflectionDataBuilder.
EyePoint
¶ Returns or sets the eye point
-------------------------------------
Getter Method
Signature
EyePoint
Returns: Return type: NXOpen.Point
New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
EyePoint
Parameters: eyePoint ( NXOpen.Point
) –New in version NX6.0.0.
License requirements: nx_general_packaging (“NX General Packaging”)
IsReflectData¶
-
ReflectionDataBuilder.
IsReflectData
¶ Returns or sets whether to create reflection data as output or not
-------------------------------------
Getter Method
Signature
IsReflectData
Returns: Return type: bool New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
IsReflectData
Parameters: isReflectData (bool) – New in version NX6.0.0.
License requirements: nx_general_packaging (“NX General Packaging”)
IsReflectTraceCurve¶
-
ReflectionDataBuilder.
IsReflectTraceCurve
¶ Returns or sets whether to create reflection trace curves as output or not
-------------------------------------
Getter Method
Signature
IsReflectTraceCurve
Returns: Return type: bool New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
IsReflectTraceCurve
Parameters: isReflectTraceCurve (bool) – New in version NX6.0.0.
License requirements: nx_general_packaging (“NX General Packaging”)
IsRefractData¶
-
ReflectionDataBuilder.
IsRefractData
¶ Returns or sets whether to create refraction data as output or not
-------------------------------------
Getter Method
Signature
IsRefractData
Returns: Return type: bool New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
IsRefractData
Parameters: isRefractData (bool) – New in version NX6.0.0.
License requirements: nx_general_packaging (“NX General Packaging”)
IsRefractTraceCurve¶
-
ReflectionDataBuilder.
IsRefractTraceCurve
¶ Returns or sets whether to create refraction trace curves as output or not
-------------------------------------
Getter Method
Signature
IsRefractTraceCurve
Returns: Return type: bool New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
IsRefractTraceCurve
Parameters: isRefractTraceCurve (bool) – New in version NX6.0.0.
License requirements: nx_general_packaging (“NX General Packaging”)
IsReverseReflectData¶
-
ReflectionDataBuilder.
IsReverseReflectData
¶ Returns or sets whether to create reverse reflection data as output or not
-------------------------------------
Getter Method
Signature
IsReverseReflectData
Returns: Return type: bool New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
IsReverseReflectData
Parameters: isReverseReflectData (bool) – New in version NX11.0.0.
License requirements: nx_general_packaging (“NX General Packaging”)
IsReverseReflectTraceCurve¶
-
ReflectionDataBuilder.
IsReverseReflectTraceCurve
¶ Returns or sets whether to create reverse reflection trace curves as output or not
-------------------------------------
Getter Method
Signature
IsReverseReflectTraceCurve
Returns: Return type: bool New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
IsReverseReflectTraceCurve
Parameters: isReverseReflectTraceCurve (bool) – New in version NX11.0.0.
License requirements: nx_general_packaging (“NX General Packaging”)
ReflectAccuracy¶
-
ReflectionDataBuilder.
ReflectAccuracy
¶ Returns or sets the customized reflection accuracy, which is the number of dispersed points for the input target objects
-------------------------------------
Getter Method
Signature
ReflectAccuracy
Returns: Return type: int New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ReflectAccuracy
Parameters: reflectAccuracy (int) – New in version NX6.0.0.
License requirements: nx_general_packaging (“NX General Packaging”)
ReflectMethod¶
-
ReflectionDataBuilder.
ReflectMethod
¶ Returns or sets the reflection data option type
-------------------------------------
Getter Method
Signature
ReflectMethod
Returns: Return type: NXOpen.Features.VehicleDesign.ReflectionDataBuilderReflectMethodType
New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ReflectMethod
Parameters: reflectionMethod ( NXOpen.Features.VehicleDesign.ReflectionDataBuilderReflectMethodType
) –New in version NX11.0.0.
License requirements: nx_general_packaging (“NX General Packaging”)
ReflectionObject¶
-
ReflectionDataBuilder.
ReflectionObject
¶ Returns the reflection object to reflect the input target objects
-------------------------------------
Getter Method
Signature
ReflectionObject
Returns: Return type: NXOpen.ScCollector
New in version NX6.0.0.
License requirements: None.
RefractionIndex¶
-
ReflectionDataBuilder.
RefractionIndex
¶ Returns or sets the refraction index
-------------------------------------
Getter Method
Signature
RefractionIndex
Returns: Return type: float New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
RefractionIndex
Parameters: refractionIndex (float) – New in version NX6.0.0.
License requirements: nx_general_packaging (“NX General Packaging”)
Resolution¶
-
ReflectionDataBuilder.
Resolution
¶ Returns or sets the resolution type
-------------------------------------
Getter Method
Signature
Resolution
Returns: Return type: NXOpen.Features.VehicleDesign.ReflectionDataBuilderResolutionType
New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Resolution
Parameters: resolution ( NXOpen.Features.VehicleDesign.ReflectionDataBuilderResolutionType
) –New in version NX6.0.0.
License requirements: nx_general_packaging (“NX General Packaging”)
ReverseDir¶
-
ReflectionDataBuilder.
ReverseDir
¶ Returns or sets whether the direction of reflection objects is reversed to determine their thickness
-------------------------------------
Getter Method
Signature
ReverseDir
Returns: Return type: bool New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ReverseDir
Parameters: reverseDir (bool) – New in version NX6.0.0.
License requirements: nx_general_packaging (“NX General Packaging”)
TargetObject¶
-
ReflectionDataBuilder.
TargetObject
¶ Returns the target object to be reflected on the faces and/or planes the target object
-------------------------------------
Getter Method
Signature
TargetObject
Returns: Return type: NXOpen.Section
New in version NX6.0.0.
License requirements: None.
Thickness¶
-
ReflectionDataBuilder.
Thickness
¶ Returns or sets the thickness of the reflection objects
-------------------------------------
Getter Method
Signature
Thickness
Returns: Return type: float New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Thickness
Parameters: thickness (float) – New in version NX6.0.0.
License requirements: nx_general_packaging (“NX General Packaging”)
Method Detail¶
Validate¶
-
ReflectionDataBuilder.
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.