Face

Type of face

Abstract Class Face

SubTypes

Fields Summary

Field
Description
actualMeshGenerator
Actual Mesh generator used by Flux to mesh the current face
color
Face Color
edge
Bordering lines of the face
meshGenerator
Mesh generator defining the mesh on the face
meshReferenceFace
nature
Nature of the face (standard, no exist or "in air")
region
Region holding the face
relaxation
Relaxation of the mesh on the face
shadow
Shadow of the mesh on the nearby faces
visibility
Face Visibility

Methods Summary

Method
Description
assignMeshGenerator
Assign mesh generator to faces (modification mode)
assignRegion
Assign regions to faces (modification mode)
assignRelaxFace
Assign relaxation to faces
assignShadowFace
Assign shadow to faces
computeAreafaces
Compute area of faces
extrude
Extrude faces
extrudeFaces
Extrude faces
mesh
Mesh faces
openSketch
Open sketch
propagate
Propagate faces
propagateFaces
Propagate faces
setInvisible
Modify face visibility
setVisible
Modify face visibility
structure
Structure faces for mapped mesh (modification mode)

Fields Details

actualMeshGenerator
actualMeshGenerator : Actual Mesh generator used by Flux to mesh the current face - [1..1] MeshGenerator
color
color : Face Color - [1..1] Color
edge
edge : Bordering lines of the face - [2..500] Line
meshGenerator
meshGenerator : Mesh generator defining the mesh on the face - [0..1] MeshGenerator
meshReferenceFace
meshReferenceFace : Mesh imposed by another face - [1..1] MeshReferenceFace
nature
nature : Nature of the face (standard, no exist or "in air") - [0..1] Nature
region
region : Region holding the face - [0..1] RegionFace
relaxation
relaxation : Relaxation of the mesh on the face - [0..1] RelaxFace
shadow
shadow : Shadow of the mesh on the nearby faces - [0..1] ShadowFace
visibility
visibility : Face Visibility - [1..1] Visibility

Method Details

assignMeshGenerator
  • Syntax

    assignMeshGenerator(meshGenerator)

  • Parameters

    • meshGenerator : Mesh generator for Faces - [0..1] MeshGenerator
  • Returns

    No return value

assignRegion
  • Syntax

    assignRegion(region)

  • Parameters

    • region : Region Face for Faces - [0..1] RegionFace
  • Returns

    No return value

assignRelaxFace
  • Syntax

    assignRelaxFace(relaxFace)

  • Parameters

    • relaxFace : Relaxation to assign to faces - [0..1] RelaxFace
  • Returns

    No return value

assignShadowFace
  • Syntax

    assignShadowFace(shadowFace)

  • Parameters

    • shadowFace : Shadow to assign to faces - [0..1] ShadowFace
  • Returns

    No return value

computeAreafaces
  • Syntax

    result = computeAreafaces()

  • Parameters

    No parameter

  • Returns

    • area : area - [0..N] Double
extrude
  • Syntax

    results = extrude(transformation, repetitionNumber, extrusionType, buildingOption)

  • Parameters

    • transformation : Transformation for extrusion - [1..1] Transf
    • repetitionNumber : Number of times to apply the transformation - [1..1] Integer
    • extrusionType : Extrusion type: Standard or Straight Forced - [1..1] Enumeration

      Potential values :

      • standard
      • straightForced
    • buildingOption : Building options for extrusion - [1..1] Enumeration

      Potential values :

      • Lines
      • Volumes
      • VolumesWithMeshGenerator
  • Returns

    • points Enumeration : points - [0..N] Point
    • stateOfPoints : state of points - [0..N] Integer
    • lines Enumeration : lines - [0..N] Line
    • stateOfLines : state of lines - [0..N] Integer
    • faces Enumeration : faces - [0..N] Face
    • stateOfFaces : state of faces - [0..N] Integer
    • volumes Enumeration : volumes - [0..N] Volume
    • stateOfVolumes : state of volumes - [0..N] Integer
extrudeFaces
  • Syntax

    extrudeFaces(transformation, repetitionNumber, extrusionType, buildingOption)

  • Parameters

    • transformation : Transformation for extrusion - [1..1] Transf
    • repetitionNumber : Number of times to apply the transformation - [1..1] Integer
    • extrusionType : Extrusion type: Standard or Straight Forced - [1..1] Enumeration

      Potential values :

      • standard
      • straightForced
    • buildingOption : Building options for extrusion - [1..1] Enumeration

      Potential values :

      • Lines
      • Volumes
  • Returns

    No return value

mesh
  • Syntax

    mesh()

  • Parameters

    No parameter

  • Returns

    No return value

openSketch
  • Syntax

    openSketch()

  • Parameters

    No parameter

  • Returns

    No return value

propagate
  • Syntax

    results = propagate(transformation, repetitionNumber, buildingOption, regionPropagation, regionPeriodicity, regionSuffix)

  • Parameters

    • transformation : Transformation for propagation - [1..1] Transf
    • repetitionNumber : Number of times to apply the transformation - [1..1] Integer
    • buildingOption : Building options for propagation - [1..1] Enumeration

      Potential values :

      • Lines
      • Faces
      • FacesWithMeshGenerator
    • regionPropagation : Regions propagation - [1..1] Enumeration

      Potential values :

      • None
      • Same
      • Increment
      • Periodicity
    • regionPeriodicity : Periodicity for regions propagation - [0..1] Integer
    • regionSuffix : Suffix for region name - [0..1] String
  • Returns

    • points Enumeration : points - [0..N] Point
    • stateOfPoints : state of points - [0..N] Integer
    • lines Enumeration : lines - [0..N] Line
    • stateOfLines : state of lines - [0..N] Integer
    • faces Enumeration : faces - [0..N] Face
    • stateOfFaces : state of faces - [0..N] Integer
propagateFaces
  • Syntax

    propagateFaces(transformation, repetitionNumber, buildingOption)

  • Parameters

    • transformation : Transformation for propagation - [1..1] Transf
    • repetitionNumber : Number of times to apply the transformation - [1..1] Integer
    • buildingOption : Building options for propagation - [1..1] Enumeration

      Potential values :

      • Lines
      • Faces
  • Returns

    No return value

setInvisible
  • Syntax

    setInvisible()

  • Parameters

    No parameter

  • Returns

    No return value

setVisible
  • Syntax

    setVisible()

  • Parameters

    No parameter

  • Returns

    No return value

structure
  • Syntax

    structure(points)

  • Parameters

    • points : Points for structure - [4..4] Point
  • Returns

    No return value