NearField
A solution near field request.
Example
application = cf.Application.getInstance() project = application:NewProject() -- Create a near field request nearFieldRequest = project.Contents.SolutionConfigurations[1].NearFields:AddCartesian(0,0,0,1,1,1,3,3,3)
Inheritance
Usage locations
The NearField object can be accessed from the following locations:
- Properties
- NearFieldOptimisationGoal object has property FocusSource.
- Methods
- NearFieldCollection collection has method Add(table).
- NearFieldCollection collection has method AddSpecifiedPoints(List of Point).
- NearFieldCollection collection has method AddCartesian(Expression, Expression, Expression, Expression, Expression, Expression, Expression, Expression, Expression).
- NearFieldCollection collection has method AddCartesianBoundary(Expression, Expression, Expression, Expression, Expression, Expression, Expression, Expression, Expression).
- NearFieldCollection collection has method AddConical(Expression, Expression, Expression, Expression, Expression, Expression, Expression, Expression).
- NearFieldCollection collection has method AddCylindrical(Expression, Expression, Expression, Expression, Expression, Expression, Expression, Expression, Expression).
- NearFieldCollection collection has method AddCylindricalX(Expression, Expression, Expression, Expression, Expression, Expression, Expression, Expression, Expression).
- NearFieldCollection collection has method AddCylindricalY(Expression, Expression, Expression, Expression, Expression, Expression, Expression, Expression, Expression).
- NearFieldCollection collection has method AddSpherical(Expression, Expression, Expression, Expression, Expression, Expression, Expression, Expression, Expression).
- NearFieldCollection collection has method Item(number).
- NearFieldCollection collection has method Item(string).
Property List
- Advanced
- Advanced properties for the near field request. (Read/Write NearFieldAdvancedSettings)
- BoundarySurface
- The near field Cartesian boundary surface settings. Only valid if DefinitionMethod is CartesianBoundary. (Read/Write NearFieldBoundarySurface)
- BoundingBox
- A box indicating the bounding box of this entity. (Read only Box). (Read only Box)
- CartesianRequestPoints
- The near field Cartesian request points. Only valid if DefinitionMethod is Cartesian. (Read/Write CartesianRequestPoints)
- ConicalRequestPoints
- The near field Conical request points. Only valid if DefinitionMethod is Conical. (Read/Write ConicalRequestPoints)
- CylindricalRequestPoints
- The near field Cylindrical request points. Only valid if DefinitionMethod is Cylindrical. (Read/Write CylindricalRequestPoints)
- CylindricalXRequestPoints
- The near field Cylindrical (X axis) request points. Only valid if DefinitionMethod is CylindricalX. (Read/Write CylindricalXRequestPoints)
- CylindricalYRequestPoints
- The near field Cylindrical (Y axis) request points. Only valid if DefinitionMethod is CylindricalY. (Read/Write CylindricalYRequestPoints)
- DefinitionMethod
- The definition method/coordinate system. (Read/Write NearFieldDefinitionMethodEnum)
- Label
- The object label. (Read/Write string)
- LocalWorkplane
- The source workplane. (Read/Write LocalWorkplane)
- PointSpecificationMethod
- The point specification method. (Read/Write PointSpecificationEnum)
- SampleOnEdgesEnabled
- Activates sampling on edges. (Read/Write boolean)
- ScopeSettings
- Near field scope settings. (Read/Write ScopeSettings)
- SpecifiedRequestPoints
- The near field group for Specified request points. Only valid if DefinitionMethod is SpecifiedPoints. (Read/Write SpecifiedRequestPoints)
- SphericalRequestPoints
- The near field Spherical request points. Only valid if DefinitionMethod is Spherical. (Read/Write SphericalRequestPoints)
- Type
- The object type string. (Read only string)
- Visible
- Specifies whether the geometry must be shown or hidden. (Read/Write boolean)
Collection List
- Transforms
- The collection of transforms on the operator. (TransformCollection of Transform.)
Method List
- CopyAndMirror (properties table)
- Apply a copy and mirror using a table defining the properties. (Returns a List of Object object.)
- CopyAndRotate (properties table, count number)
- Apply a copy and rotate using a table defining the properties. (Returns a List of Object object.)
- CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number)
- Copy and rotate the geometry. (Returns a List of Object object.)
- CopyAndTranslate (properties table, count number)
- Apply a copy and translate using a table defining the properties. (Returns a List of Object object.)
- CopyAndTranslate (from Point, to Point, count number)
- Copy and translate the geometry. (Returns a List of Object object.)
- Delete ()
- Deletes the entity.
- Duplicate ()
- Duplicates the entity. (Returns a Object object.)
- GetProperties ()
- Returns a table of properties representing the state of the object. The properties table can be used with the SetProperties method to change multiple properties of the object in one step. (Returns a table object.)
- SetProperties (properties Object)
- Modifies the state of the object using the provided table of properties. This method is used to modify multiple properties of the object in a single step.
Static Function List
- GetDefaultProperties ()
- Creates a table containing the default settings to create an object. (Returns a table object.)
Property Details
- Advanced
- Advanced properties for the near field request.
- Type
- NearFieldAdvancedSettings
- Access
- Read/Write
- BoundarySurface
- The near field Cartesian boundary surface settings. Only valid if DefinitionMethod is CartesianBoundary.
- Type
- NearFieldBoundarySurface
- Access
- Read/Write
- BoundingBox
- A box indicating the bounding box of this entity. (Read only Box).
- Type
- Box
- Access
- Read only
- CartesianRequestPoints
- The near field Cartesian request points. Only valid if DefinitionMethod is Cartesian.
- Type
- CartesianRequestPoints
- Access
- Read/Write
- ConicalRequestPoints
- The near field Conical request points. Only valid if DefinitionMethod is Conical.
- Type
- ConicalRequestPoints
- Access
- Read/Write
- CylindricalRequestPoints
- The near field Cylindrical request points. Only valid if DefinitionMethod is Cylindrical.
- Type
- CylindricalRequestPoints
- Access
- Read/Write
- CylindricalXRequestPoints
- The near field Cylindrical (X axis) request points. Only valid if DefinitionMethod is CylindricalX.
- Type
- CylindricalXRequestPoints
- Access
- Read/Write
- CylindricalYRequestPoints
- The near field Cylindrical (Y axis) request points. Only valid if DefinitionMethod is CylindricalY.
- Type
- CylindricalYRequestPoints
- Access
- Read/Write
- DefinitionMethod
- The definition method/coordinate system.
- Type
- NearFieldDefinitionMethodEnum
- Access
- Read/Write
- Label
- The object label.
- Type
- string
- Access
- Read/Write
- LocalWorkplane
- The source workplane.
- Type
- LocalWorkplane
- Access
- Read/Write
- PointSpecificationMethod
- The point specification method.
- Type
- PointSpecificationEnum
- Access
- Read/Write
- SampleOnEdgesEnabled
- Activates sampling on edges.
- Type
- boolean
- Access
- Read/Write
- ScopeSettings
- Near field scope settings.
- Type
- ScopeSettings
- Access
- Read/Write
- SpecifiedRequestPoints
- The near field group for Specified request points. Only valid if DefinitionMethod is SpecifiedPoints.
- Type
- SpecifiedRequestPoints
- Access
- Read/Write
- SphericalRequestPoints
- The near field Spherical request points. Only valid if DefinitionMethod is Spherical.
- Type
- SphericalRequestPoints
- Access
- Read/Write
- Type
- The object type string.
- Type
- string
- Access
- Read only
- Visible
- Specifies whether the geometry must be shown or hidden.
- Type
- boolean
- Access
- Read/Write
Collection Details
- Transforms
- The collection of transforms on the operator.
- Type
- TransformCollection
Method Details
- CopyAndMirror (properties table)
- Apply a copy and mirror using a table defining the properties.
- CopyAndRotate (properties table, count number)
- Apply a copy and rotate using a table defining the properties.
- CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number)
- Copy and rotate the geometry.
- CopyAndTranslate (properties table, count number)
- Apply a copy and translate using a table defining the properties.
- CopyAndTranslate (from Point, to Point, count number)
- Copy and translate the geometry.
- Delete ()
- Deletes the entity.
- Duplicate ()
- Duplicates the entity.
- Return
- Object
- The new (duplicated) entity.
- GetProperties ()
- Returns a table of properties representing the state of the object. The properties table can be used with the SetProperties method to change multiple properties of the object in one step.
- Return
- table
- A table defining the properties.
- SetProperties (properties Object)
- Modifies the state of the object using the provided table of properties. This method is used to modify multiple properties of the object in a single step.
- Input Parameters
- properties(Object)
- A table of properties defining the new state of the object.
Static Function Details
- GetDefaultProperties ()
- Creates a table containing the default settings to create an object.
- Return
- table
- A table containing the default properties.