Skip to main content

optiSLang 3D Postprocessing Script API 2025 R1

CoorTransformationBase Class Reference

Last update: 16.07.2025

An abstract base class that provides a generic API for different methods that apply rigid coordinate transformations. More...

Public Types

enum  Type {
  eNEUTRAL_TRANS =0, eCOARSE_TRANS, eCOARSE_ROT, eCOARSE_ROT_TRANS,
  eFINE_ROT_TRANS, eFINE_ROT_TRANS_PREALIGNED
}
 an enum type defining the type of the derived class More...
 

Public Member Functions

 applyTransformation (MeshMapperBase mapper, Structure ref_structure, Structure other_structure)
 Applies the coordinate transformation to the other_structure. More...
 
virtual bool doesNonRigid ()=0
 
virtual bool doesRotate ()=0
 
virtual bool doesTranslate ()=0
 
virtual string generateScriptOfSettingsDefinition (string variable_ident)=0
 generates a script string (Lua) that is used to build up this object. More...
 
virtual Type trafoType ()=0
 

Public Attributes

std::pair< string, string > trafo_ref_node_set
 The ident of the reference node set the transformation algorithms will be limited to set up their optimization criterion. More...
 

Detailed Description

An abstract base class that provides a generic API for different methods that apply rigid coordinate transformations.

Examples are:

Member Enumeration Documentation

◆ Type

enum Type

an enum type defining the type of the derived class

Enumerator
eNEUTRAL_TRANS 

Neutral transformation.

eCOARSE_TRANS 

CoarseTranslation.

eCOARSE_ROT 

CoarseRotation.

eCOARSE_ROT_TRANS 

CoarseRigidTransformation.

eFINE_ROT_TRANS 

FineRigidTransformation.

eFINE_ROT_TRANS_PREALIGNED 

FineRigidTransformation of pre-aligned point clouds.

Member Function Documentation

◆ applyTransformation()

applyTransformation ( MeshMapperBase  mapper,
Structure  ref_structure,
Structure  other_structure 
)

Applies the coordinate transformation to the other_structure.

If a transformation reference node set has been defined, only those nodes included in the sets will be used to determine the transformation matrix. Otherwise all nodes of both structures will be used for the determination algorithm. Nevertheless, the transformation itself will be applied to all nodes of the other_structure. It might also occur, that the reference node set cannot be found in the other_structure. In such a case, the reference node set will be projected onto the segments of the other_structure and used as virtual node set.

Parameters
[in]mapperA back reference to the current mesh mapper. This one might be needed if a defined reference node set cannot be found in the other_structure
[in]ref_structureThe reference mesh
[in,out]other_structureOn input the imported mesh. On output the mesh with modified coordinates.

◆ doesNonRigid()

virtual bool doesNonRigid ( )
pure virtual
Returns
true if this transformation applies a non-rigid operation

Implemented in NeutralCoorTransformation, and CoarseRotation.

◆ doesRotate()

virtual bool doesRotate ( )
pure virtual
Returns
true if this transformation applies a rigid rotation

Implemented in NeutralCoorTransformation, and CoarseRotation.

◆ doesTranslate()

virtual bool doesTranslate ( )
pure virtual
Returns
true if this transformation applies a rigid translation

Implemented in NeutralCoorTransformation, and CoarseRotation.

◆ generateScriptOfSettingsDefinition()

virtual string generateScriptOfSettingsDefinition ( string  variable_ident)
pure virtual

generates a script string (Lua) that is used to build up this object.

Returns
the script code, ends with newline.
Parameters
variable_identthe ident of the Lua variable that contains the MeshMapper object

Implemented in NeutralCoorTransformation, CoarseRotation, CoarseRigidTransformation, and CoarseTranslation.

◆ trafoType()

virtual Type trafoType ( )
pure virtual
Returns
the type of the transformation

Implemented in NeutralCoorTransformation, CoarseRotation, CoarseRigidTransformation, and CoarseTranslation.

Member Data Documentation

◆ trafo_ref_node_set

std::pair< string, string > trafo_ref_node_set

The ident of the reference node set the transformation algorithms will be limited to set up their optimization criterion.

A pair consisting of the part ident as first and the set ident as second member.

Connect with Ansys