LocalWorkplane

Example

application = cf.Application.getInstance()
project = application:NewProject()

    -- Create a flare

baseCentre = cf.Point(-0.25, -0.25, 0)
flare = project.Contents.Geometry:AddFlare(baseCentre, 0.5, 0.5, 1.0, 0.3, 0.3)

    -- Modify the local workplane of the flare

flare.LocalWorkplane.WorkplaneDefinitionOption = cf.Enums.LocalWorkplaneDefinitionEnum.UseCustomDefinedWorkplane
lwp = flare.LocalWorkplane.LocalDefinedWorkplane
lwp.Origin.X = 1
lwp.Origin.Z = .3
lwp.UVector.Y = 1
lwp.VVector.Z = -2

Inheritance

The LocalWorkplane object is derived from the CompositeValue object.

Usage locations

The LocalWorkplane object can be accessed from the following locations:

• Properties
  • GeometryGroup collection has property LocalWorkplane.
  • Transform object has property LocalWorkplane.
  • Align object has property DestinationWorkplane.
  • Align object has property SourceWorkplane.
  • Align object has property LocalWorkplane.
  • Mirror object has property LocalWorkplane.
  • Rotate object has property LocalWorkplane.
  • Scale object has property LocalWorkplane.
  • Translate object has property LocalWorkplane.
  • NamedPoint object has property LocalWorkplane.
  • Workplane object has property LocalWorkplane.
  • AbstractAntennaArray object has property LocalWorkplane.
  • CylindricalAntennaArray object has property LocalWorkplane.
  • LinearPlanarArray object has property LocalWorkplane.
  • CustomAntennaArray object has property LocalWorkplane.
  • Cutplane object has property LocalWorkplane.
  • CablePath object has property LocalWorkplane.
  • FieldData object has property LocalWorkplane.
  • SolutionCoefficientData object has property LocalWorkplane.
  • PCBCurrentData object has property LocalWorkplane.
  • SphericalModeDataManuallySpecified object has property LocalWorkplane.
  • SphericalModeDataFromFile object has property LocalWorkplane.
  • NearFieldDataFullImport object has property LocalWorkplane.
  • NearFieldDataFileStructure object has property LocalWorkplane.
  • FarFieldData object has property LocalWorkplane.
  • MeshRefinementRule object has property LocalWorkplane.
  • AdaptiveRefinement object has property LocalWorkplane.
  • PointRefinement object has property LocalWorkplane.
  • PolylineRefinement object has property LocalWorkplane.
  • Mesh object has property LocalWorkplane.
  • Geometry object has property LocalWorkplane.
  • AnalyticalCurve object has property LocalWorkplane.
  • BezierCurve object has property LocalWorkplane.
  • Cone object has property LocalWorkplane.
  • ConstrainedSurface object has property LocalWorkplane.
  • Cuboid object has property LocalWorkplane.
  • Cylinder object has property LocalWorkplane.
  • Ellipse object has property LocalWorkplane.
  • EllipticArc object has property LocalWorkplane.
  • FittedSpline object has property LocalWorkplane.
  • Flare object has property LocalWorkplane.
  • Helix object has property LocalWorkplane.
  • HyperbolicArc object has property LocalWorkplane.
  • ImprintPoints object has property LocalWorkplane.
  • Intersect object has property LocalWorkplane.
  • Loft object has property LocalWorkplane.
  • PathSweep object has property LocalWorkplane.
  • ProjectGeometry object has property LocalWorkplane.
  • RepairAndSewFaces object has property LocalWorkplane.
  • RepairPart object has property LocalWorkplane.
  • Spin object has property LocalWorkplane.
  • Split object has property LocalWorkplane.
  • Stitch object has property LocalWorkplane.
  • Subtract object has property LocalWorkplane.
  • Sweep object has property LocalWorkplane.
  • Union object has property LocalWorkplane.
  • Simplify object has property LocalWorkplane.
  • Line object has property LocalWorkplane.
  • NurbsSurface object has property LocalWorkplane.
  • ParabolicArc object has property LocalWorkplane.
  • Paraboloid object has property LocalWorkplane.
  • Polygon object has property LocalWorkplane.
  • Polyline object has property LocalWorkplane.
  • Primitive object has property LocalWorkplane.
  • Rectangle object has property LocalWorkplane.
  • Sphere object has property LocalWorkplane.
  • AbstractSurfaceCurve object has property LocalWorkplane.
  • SurfaceBezierCurve object has property LocalWorkplane.
  • SurfaceLine object has property LocalWorkplane.
  • SurfaceRegularLines object has property LocalWorkplane.
  • AbstractFEMLinePort object has property LocalWorkplane.
  • FEMLineMeshPort object has property LocalWorkplane.
  • FEMLinePort object has property LocalWorkplane.
  • FEMModalMeshPort object has property LocalWorkplane.
  • FEMModalPort object has property LocalWorkplane.
  • AbstractIdealSource object has property LocalWorkplane.
  • AbstractPointSource object has property LocalWorkplane.
  • ElectricDipole object has property LocalWorkplane.
  • MagneticDipole object has property LocalWorkplane.
  • ImpressedCurrent object has property LocalWorkplane.
  • FarFieldSource object has property LocalWorkplane.
  • NearFieldSource object has property LocalWorkplane.
  • PCBSource object has property LocalWorkplane.
  • SolutionCoefficientSource object has property LocalWorkplane.
  • SphericalModeSource object has property LocalWorkplane.
  • PlaneWave object has property LocalWorkplane.
  • FarField object has property LocalWorkplane.
  • BaseFieldReceivingAntenna object has property LocalWorkplane.
  • FarFieldReceivingAntenna object has property LocalWorkplane.
  • NearFieldReceivingAntenna object has property LocalWorkplane.
  • SphericalModeReceivingAntenna object has property LocalWorkplane.
  • ModelDecomposition object has property LocalWorkplane.
  • NearField object has property LocalWorkplane.
  • PeriodicBoundary object has property LocalWorkplane.
  • ProtectedModel object has property LocalWorkplane.
• Methods
  • LocalWorkplaneList object has method append().
  • LocalWorkplaneList object has method get(number).

Property List

LocalDefinedWorkplane

The local defined workplane. (Read/Write GlobalPlane)

ReferencedWorkplane

The referenced workplane. (Read/Write Workplane)

WorkplaneDefinitionOption

Options for defining a workplane. (Read/Write LocalWorkplaneDefinitionEnum)

Property Details

LocalDefinedWorkplane

The local defined workplane.

Type

GlobalPlane

Access

Read/Write

ReferencedWorkplane

The referenced workplane.

Type

Workplane

Access

Read/Write

WorkplaneDefinitionOption

Options for defining a workplane.

Type

LocalWorkplaneDefinitionEnum

Access

Read/Write