SimulationMeshWireEntity
Inheritance
The SimulationMeshWireEntity object is derived from the AbstractSimulationMeshWireEntity object.
Usage locations
The SimulationMeshWireEntity object can be accessed from the following locations:
- Methods
- SimulationMeshWireCollection collection has method Item(number).
- SimulationMeshWireCollection collection has method Item(string).
Property List
Property List (internal only)
- AdditionalVertexPositions
- (Read only List of Point)
- CutsGroundPlane
- (Read only boolean)
- CutsSymmetryPlane
- (Read only boolean)
- EstimatedMemory
- (Read only number)
- EstimatedNumberOfElements
- (Read only number)
- HasSymmetricPartnerInMeshableRegion
- (Read only boolean)
- IsInMeshableRegion
- (Read only boolean)
- IsProtectedMesh
- (Read only boolean)
- LiesOnGroundPlane
- (Read only boolean)
- LiesOnSymmetryPlane
- (Read only boolean)
- MeshSize
- (Read only number)
- Path
- (Read only string)
- Ports
- (Read only List of Port)
- Radius
- (Read only number)
- ScaleFactor
- (Read only number)
- ShowProtectedMesh
- (Read only boolean)
- SourceGeometryEntities
- (Read/Write ObjectReferenceList)
- SourceMeshEntities
- (Read/Write ObjectReferenceList)
- SourcePath
- (Read only string)
- SymmetryRegionIndex
- (Read/Write number)
- Tolerance
- (Read only number)
Method List
- 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
Property Details (internal only)
- AdditionalVertexPositions
- Access
- Read only
- CutsGroundPlane
- Type
- boolean
- Access
- Read only
- CutsSymmetryPlane
- Type
- boolean
- Access
- Read only
- EstimatedMemory
- Type
- number
- Access
- Read only
- EstimatedNumberOfElements
- Type
- number
- Access
- Read only
- HasSymmetricPartnerInMeshableRegion
- Type
- boolean
- Access
- Read only
- IsInMeshableRegion
- Type
- boolean
- Access
- Read only
- IsProtectedMesh
- Type
- boolean
- Access
- Read only
- LiesOnGroundPlane
- Type
- boolean
- Access
- Read only
- LiesOnSymmetryPlane
- Type
- boolean
- Access
- Read only
- MeshSize
- Type
- number
- Access
- Read only
- Path
- Type
- string
- Access
- Read only
- Ports
- Access
- Read only
- Radius
- Type
- number
- Access
- Read only
- ScaleFactor
- Type
- number
- Access
- Read only
- ShowProtectedMesh
- Type
- boolean
- Access
- Read only
- SourceGeometryEntities
- Type
- ObjectReferenceList
- Access
- Read/Write
- SourceMeshEntities
- Type
- ObjectReferenceList
- Access
- Read/Write
- SourcePath
- Type
- string
- Access
- Read only
- SymmetryRegionIndex
- Type
- number
- Access
- Read/Write
- Tolerance
- Type
- number
- Access
- Read only
Method Details
- 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.