RFShell.SetCoordinateMode

Description

Sets the coordinate mode of the shell which could be either local i.e. measured or global.

Syntax

Function RFShell.SetCoordinateMode(coordMode As RFCoordinateMode) As RFErrorCode

The SetCoordinateMode syntax has these parts:

Remarks

• A shell can have an additional coordinate system of its own, which is referred to as local coordinate system. Sometimes it is also called measuring coordinate system, but it does not imply shell's coordinate system should always be associated with 3D scanning information. All the shells do not necessarily have a local coordinate system.
• Shell!'s local coordinate system can be defined and modified dynamically by RFShell.SetMeasuringCoordinate method. Shell and its belongings geometrical information such as vertex position, face normal, etc. will be provided with respect to the current coordinate system in use, which can be dynamically switched by this RFShell.SetCoordinateMode method.
• Note that all reference geometry entities, NURBS curve, and NURBS surface connected to a shell use only global coordinate system.
  

• When the type of the shell is not RF_MEASURED_SHELL , which can be checked by RFShell.GetType method, this method will not work.
• RFVertex.GetPoint, RFVertex.CalcNormal, RFFace.GetPoints, RFFace.CalcNormal, and RFFace.CalcAverageNormal refer the shell's current coordinate mode.

Sample

Dim rfErr As RFErrorCode
Dim mdObj As RapidForm.RFModel
Dim shObj As RapidForm.RFShell
Dim vtObj As RapidForm.RFVertex

    Set mdObj = RapidForm.Model
    Set shObj = RapidForm.Shell
    Set vtObj = RapidForm.Vertex
    
    Dim shID As RFEntityID
    
    ' Add a blank sell.
    shID = mdObj.AddShell(RF_MEASURED_SHELL, "Simple shell")
    
    ' Register the shell in the GUI database.
    rfErr = RapidForm.UserInterface.AddShellToProjectTree(shID)
    
    rfErr = shObj.SetID(shID)
            
    ' Define the local coordinate of the shell as follows,
    ' The origin = {0,0,10}
    ' U axis = {0,1,0}
    ' V axis = {1,0,0}
    rfErr = shObj.SetMeasuringCoordinate(0, 0, 10, 0, 1, 0, 1, 0, 0)
    
    ' Retreives the local to global transformation matrix.
    Dim l2gMat As RFTMatrix
    rfErr = shObj.GetLocalToGlobalMatrix(l2gMat)
    
    ' Retreives the global to local transformation matrix.
    Dim g2lMat As RFTMatrix
    rfErr = shObj.GetLocalToGlobalMatrix(g2lMat)
    
    ' Add {5,10,-5} point of the local coordinate system as a new vertex in the shell.
    ' All vertex coordinates passed in the AddVertex method are interpreted in reference to the global coordinate.
    Dim orgPt As RFPoint3
    Dim vtID As RFEntityID
    
    orgPt.x = 5
    orgPt.y = 10
    orgPt.z = -5
    
    ' Get the global coordinates of orgPt
    Dim globalPt As RFPoint3
    globalPt.x = l2gMat.m(0, 0) * orgPt.x + l2gMat.m(1, 0) * orgPt.y + l2gMat.m(2, 0) * orgPt.z + l2gMat.m(3, 0)
    globalPt.y = l2gMat.m(0, 1) * orgPt.x + l2gMat.m(1, 1) * orgPt.y + l2gMat.m(2, 1) * orgPt.z + l2gMat.m(3, 1)
    globalPt.z = l2gMat.m(0, 2) * orgPt.x + l2gMat.m(1, 2) * orgPt.y + l2gMat.m(2, 2) * orgPt.z + l2gMat.m(3, 2)
    
    rfErr = shObj.AddVertex(globalPt.x, globalPt.y, globalPt.z, vtID)

    rfErr = vtObj.SetID(vtID)
    
    ' Retrieves the first vertex coordinates in the local coordinate system.
    Dim localPt As RFPoint3
    rfErr = shObj.SetCoordinateMode(RF_LOCAL_COORDINATE_MODE)
    rfErr = vtObj.GetPoint(localPt)
    
    ' Retrieves the first vertex coordinates in the global coordinate system.
    rfErr = shObj.SetCoordinateMode(RF_GLOBAL_COORDINATE_MODE)
    rfErr = vtObj.GetPoint(globalPt)
    
    ' Update the GUI database and redraw the scene.
    rfErr = RapidForm.Document.RegenShell(shID)
    RapidForm.Document.RedrawScene