Click or drag to resize
GetTransform Methods

The GetTransform type exposes the following members.

Methods
  NameDescription
Public methodAcceptColor
If you want to allow the user to be able to type in a color r,g,b or name during GetPoint.Get(), GetObject::GetObjects(), etc., then call AcceptColor(true) before calling GetPoint()/GetObject(). If the user chooses to type in a color, then the result code GetResult.Color is returned and you can use RhinoGet.Color() to get the value of the color. If the get accepts points, then the user will not be able to type in r,g,b colors but will be able to type color names.
(Inherited from GetBaseClass.)
Public methodAcceptCustomMessage (Inherited from GetBaseClass.)
Public methodCode exampleAcceptNothing
If you want to allow the user to be able to press enter in order to skip selecting a something in GetPoint.Get(), GetObject::GetObjects(), etc., then call AcceptNothing( true ) beforehand.
(Inherited from GetBaseClass.)
Public methodAcceptNumber
If you want to allow the user to be able to type in a number during GetPoint.Get(), GetObject::GetObjects(), etc., then call AcceptNumber() beforehand. If the user chooses to type in a number, then the result code GetResult.Number is returned and you can use RhinoGet.Number() to get the value of the number. If you are using GetPoint and you want "0" to return (0,0,0) instead of the number zero, then set acceptZero = false.
(Inherited from GetBaseClass.)
Public methodAcceptPoint
If you want to allow the user to be able to type in a point then call AcceptPoint(true) before calling GetPoint()/GetObject(). If the user chooses to type in a number, then the result code GetResult.Point is returned and you can use RhinoGet.Point() to get the value of the point.
(Inherited from GetBaseClass.)
Public methodAcceptString
If you want to allow the user to be able to type in a string during GetPoint.Get(), GetObject::GetObjects(), etc., then call AcceptString(true) before calling GetPoint()/GetObject(). If the user chooses to type in a string, then the result code GetResult.String is returned and you can use RhinoGet.String() to get the value of the string.
(Inherited from GetBaseClass.)
Public methodAcceptUndo
If you want to allow the user to have an 'undo' option in GetPoint.Get(), GetObject.GetObjects(), etc., then call AcceptUndo(true) beforehand.
(Inherited from GetBaseClass.)
Public methodAddConstructionPoint
Adds a point to the list of construction points.
(Inherited from GetPoint.)
Public methodAddConstructionPoints
Adds points to the list of construction points.
(Inherited from GetPoint.)
Public methodCode exampleAddOption(String)
Adds a command line option.
(Inherited from GetBaseClass.)
Public methodAddOption(LocalizeStringPair)
Adds a command line option.
(Inherited from GetBaseClass.)
Public methodAddOption(String, String)
Adds a command line option.
(Inherited from GetBaseClass.)
Public methodAddOption(LocalizeStringPair, LocalizeStringPair)
Adds a command line option.
(Inherited from GetBaseClass.)
Public methodAddOptionColor(String, OptionColor)
Add a command line option to get colors and automatically save the value.
(Inherited from GetBaseClass.)
Public methodAddOptionColor(LocalizeStringPair, OptionColor)
Add a command line option to get colors and automatically save the value.
(Inherited from GetBaseClass.)
Public methodAddOptionColor(String, OptionColor, String)
Add a command line option to get colors and automatically save the value.
(Inherited from GetBaseClass.)
Public methodAddOptionColor(LocalizeStringPair, OptionColor, String)
Add a command line option to get colors and automatically save the value.
(Inherited from GetBaseClass.)
Public methodCode exampleAddOptionDouble(String, OptionDouble)
Adds a command line option to get numbers and automatically save the value.
(Inherited from GetBaseClass.)
Public methodCode exampleAddOptionDouble(LocalizeStringPair, OptionDouble)
Adds a command line option to get numbers and automatically save the value.
(Inherited from GetBaseClass.)
Public methodAddOptionDouble(String, OptionDouble, String)
Adds a command line option to get numbers and automatically save the value.
(Inherited from GetBaseClass.)
Public methodAddOptionDouble(LocalizeStringPair, OptionDouble, String)
Adds a command line option to get numbers and automatically saves the value.
(Inherited from GetBaseClass.)
Public methodAddOptionEnumListT
Add a choice of enum values as list option
(Inherited from GetBaseClass.)
Public methodAddOptionEnumSelectionListT
Add a list of enum values as option list. Use enumSelection[go.Option.CurrentListOptionIndex] to retrieve selection.
(Inherited from GetBaseClass.)
Public methodCode exampleAddOptionInteger(String, OptionInteger)
Adds a command line option to get integers and automatically save the value.
(Inherited from GetBaseClass.)
Public methodCode exampleAddOptionInteger(LocalizeStringPair, OptionInteger)
Adds a command line option to get integers and automatically save the value.
(Inherited from GetBaseClass.)
Public methodAddOptionInteger(String, OptionInteger, String)
Adds a command line option to get integers and automatically save the value.
(Inherited from GetBaseClass.)
Public methodAddOptionInteger(LocalizeStringPair, OptionInteger, String)
Adds a command line option to get integers and automatically save the value.
(Inherited from GetBaseClass.)
Public methodCode exampleAddOptionList(String, IEnumerableString, Int32)
Adds a command line list option.
(Inherited from GetBaseClass.)
Public methodCode exampleAddOptionList(LocalizeStringPair, IEnumerableLocalizeStringPair, Int32)
Adds a command line list option.
(Inherited from GetBaseClass.)
Public methodCode exampleAddOptionToggle(String, OptionToggle)
Adds a command line option to toggle a setting.
(Inherited from GetBaseClass.)
Public methodCode exampleAddOptionToggle(LocalizeStringPair, OptionToggle)
Adds a command line option to toggle a setting.
(Inherited from GetBaseClass.)
Public methodAddSnapPoint
Adds a point to the list of osnap points.
(Inherited from GetPoint.)
Public methodAddSnapPoints
Adds points to the list of osnap points.
(Inherited from GetPoint.)
Public methodAddTransformObjects
Adds any objects you want transformed and grips you want transformed. Make sure no duplicates are in the list and that no grip ownwers are passed in as objects.
Public methodCalculateTransform
Retrieves the final transformation.

Override this virtual function to provide your own custom transformation method.

Public methodCode exampleClearCommandOptions
Clear all command options.
(Inherited from GetBaseClass.)
Public methodCode exampleClearConstraints
Removes any explicit constraints added by calls to GetPoint::Constraint() and enable the built-in constraint options.
(Inherited from GetPoint.)
Public methodClearConstructionPoints
Remove all construction points.
(Inherited from GetPoint.)
Public methodClearDefault
Clears any defaults set using SetDefaultPoint, SetDefaultNumber, SetDefaultString, or SetCommandPromptDefault.
(Inherited from GetBaseClass.)
Public methodClearSnapPoints
Remove all snap points.
(Inherited from GetPoint.)
Public methodColor
Gets a color if Get*() returns GetResult.Color.
(Inherited from GetBaseClass.)
Public methodCode exampleCommandResult
Helper method for getting command result value from getter results.
(Inherited from GetBaseClass.)
Public methodConstrain(Arc)
Constrains the picked point to lie on an arc.
(Inherited from GetPoint.)
Public methodConstrain(Circle)
Constrains the picked point to lie on a circle.
(Inherited from GetPoint.)
Public methodConstrain(Cylinder)
Constrains the picked point to lie on a cylinder.
(Inherited from GetPoint.)
Public methodCode exampleConstrain(Line)
Constrains the picked point to lie on a line.
(Inherited from GetPoint.)
Public methodConstrain(Sphere)
Constrains the picked point to lie on a sphere.
(Inherited from GetPoint.)
Public methodCode exampleConstrain(Curve, Boolean)
Constrains the picked point to lie on a curve.
(Inherited from GetPoint.)
Public methodConstrain(Mesh, Boolean)
Constrains the picked point to lie on a mesh.
(Inherited from GetPoint.)
Public methodConstrain(Plane, Boolean)
constrain the picked point to lie on a plane.
(Inherited from GetPoint.)
Public methodCode exampleConstrain(Point3d, Point3d)
Constrains the picked point to lie on a line.
(Inherited from GetPoint.)
Public methodCode exampleConstrain(Surface, Boolean)
Constrains the picked point to lie on a surface.
(Inherited from GetPoint.)
Public methodConstrain(Brep, Int32, Int32, Boolean)
Constrains the picked point to lie on a brep.
(Inherited from GetPoint.)
Public methodConstrainDistanceFromBasePoint
Sets distance constraint from base point.
(Inherited from GetPoint.)
Public methodCode exampleConstrainToConstructionPlane
If enabled, the picked point is constrained to be on the active construction plane. If the base point is set, then the point is constrained to be on the plane that contains the base point and is parallel to the active construction plane. By default this constraint is enabled.
(Inherited from GetPoint.)
Public methodConstrainToTargetPlane
Constrains point to lie on a plane that is parallel to the viewing plane and passes through the view's target point.
(Inherited from GetPoint.)
Public methodConstrainToVirtualCPlaneIntersection
If enabled, the picked point is constrained to be on the intersection of the plane and the virtual CPlane going through the plane origin. If the planes are parallel, the constraint works just like planar constraint.
(Inherited from GetPoint.)
Public methodCustomMessage (Inherited from GetBaseClass.)
Public methodDispose (Inherited from GetBaseClass.)
Protected methodDispose(Boolean) (Inherited from GetBaseClass.)
Public methodCode exampleDrawLineFromPoint
Use DrawLineFromPoint() if you want a dynamic line drawn from a point to the point being picked.
(Inherited from GetPoint.)
Public methodEnableCurveSnapArrow
Controls display of the curve snap arrow icon.
(Inherited from GetPoint.)
Public methodEnableCurveSnapPerpBar
Controls display of the curve snap perpendicular bar icon.
(Inherited from GetPoint.)
Public methodEnableCurveSnapTangentBar
Controls display of the curve snap tangent bar icon.
(Inherited from GetPoint.)
Public methodEnableDrawLineFromPoint
Controls drawing of dynamic a line from the start point.
(Inherited from GetPoint.)
Public methodEnableSnapToCurves
If you want GetPoint() to try to snap to curves when the mouse is near a curve (like the center point in the Circle command when the AroundCurve option is on), then enable the snap to curves option.
(Inherited from GetPoint.)
Public methodEnableTransparentCommands
Control the availability of transparent commands during the get.
(Inherited from GetBaseClass.)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize (Inherited from GetBaseClass.)
Public methodCode exampleGet
After setting up options and so on, call GetPoint::Get to get a 3d point. The point is retrieved when the mouse goes down.
(Inherited from GetPoint.)
Public methodGet(Boolean)
After setting up options and so on, call this method to get a 3d point.
(Inherited from GetPoint.)
Public methodGetConstructionPoints
Gets current construction points.
(Inherited from GetPoint.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetSelectedEnumValueT (Inherited from GetBaseClass.)
Public methodGetSelectedEnumValueFromSelectionListT (Inherited from GetBaseClass.)
Public methodGetSnapPoints
Gets current snap points.
(Inherited from GetPoint.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetXform
Gets the Transformation.

Call this after having set up options and so on.

Public methodGotDefault
Returns true if user pressed Enter to accept a default point, number, or string set using SetDefaultPoint, SetDefaultNumber, or SetDefaultString.
(Inherited from GetBaseClass.)
Public methodInterruptMouseMove
If you have lengthy computations in OnMouseMove() and/or DymanicDraw() overrides, then periodically call InterruptMouseMove() to see if you should interrupt your work because the mouse has moved again.
(Inherited from GetPoint.)
Public methodLine2d
Returns two points defining the location in the view window of the 2d line selected in GetPoint::Get2dLine().

(0,0) = upper left corner of window.

(Inherited from GetBaseClass.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodCode exampleNumber
Gets a number if GetPoint.Get(), GetObject.GetObjects(), etc., returns GetResult.Number.
(Inherited from GetBaseClass.)
Protected methodCode exampleOnDynamicDraw
Default calls the DynamicDraw event.
(Inherited from GetPoint.)
Protected methodOnMouseDown
Default calls the MouseDown event.
(Inherited from GetPoint.)
Protected methodOnMouseMove
Calls the MouseMove event and can/should be called by overriding implementation.
(Inherited from GetPoint.)
Protected methodOnPostDrawObjects
In the "rare" case that you need to draw some depth buffered geometry during a GetPoint operation, override the OnPostDrawObjects function. NOTE!! Overriding this function comes with a significant performance penalty because the scene needs to be fully regenerated every frame where the standard DynamicDraw event draws temporary decorations (geometry) on top of a static scene.
(Inherited from GetPoint.)
Public methodOption (Inherited from GetBaseClass.)
Public methodOptionIndex (Inherited from GetBaseClass.)
Public methodPermitConstraintOptions
Control the availability of the built-in linear, planar, curve, and surface constraint options like "Along", "AlongPerp", "AlongTan", "AlongParallel", "Between", "OnCrv", "OnSrf", ".x", ".y", ".z", ".xy", etc.
(Inherited from GetPoint.)
Public methodPermitElevatorMode
Permits the use of the control key to define a line constraint.
(Inherited from GetPoint.)
Public methodPermitFromOption
Control the availability of the built-in "From" option. By default, the "From" option is enabled.
(Inherited from GetPoint.)
Public methodPermitObjectSnap
By default, object snaps like "end", "near", etc. are controled by the user. If you want to disable this ability, then call PermitObjectSnap(false).
(Inherited from GetPoint.)
Public methodPermitOrthoSnap
Controls availability of ortho snap. Default is true.
(Inherited from GetPoint.)
Public methodPermitTabMode
Permits the use of the tab key to define a line constraint.
(Inherited from GetPoint.)
Public methodPickRectangle
If the get was a GetObjects() and the mouse was used to select the objects, then the returned rect has left < right and top < bottom. This rect is the Windows GDI screen coordinates of the picking rectangle. RhinoViewport.GetPickXform( pick_rect, pick_xform ) will calculate the picking transformation that was used. In all other cases, left=right=top=bottom=0;
(Inherited from GetBaseClass.)
Public methodCode examplePoint
Gets a point if Get*() returns GetResult.Point.
(Inherited from GetBaseClass.)
Public methodPoint2d
Returns location in view of point in selected in GetPoint::Get() or GetPoint::Get2dPoint(). (0,0) = upper left corner of window.
(Inherited from GetBaseClass.)
Public methodCode examplePointOnCurve
Use to determine is point was on a curve.
(Inherited from GetPoint.)
Public methodPointOnObject
Call this function to see if the point was on an object. If the point was on an object an ObjRef is returned; otherwise null is returned.
(Inherited from GetPoint.)
Public methodRectangle2d
Returns the location in the view of the 2d rectangle selected in GetPoint::Get2dRectangle(). rect.left < rect.right and rect.top < rect.bottom (0,0) = upper left corner of window.
(Inherited from GetBaseClass.)
Public methodResult
Returns result of the Get*() call.
(Inherited from GetBaseClass.)
Public methodCode exampleSetBasePoint
Sets a base point used by ortho snap, from snap, planar snap, etc.
(Inherited from GetPoint.)
Public methodCode exampleSetCommandPrompt
Sets prompt message that appears in the command prompt window.
(Inherited from GetBaseClass.)
Public methodCode exampleSetCommandPromptDefault
Sets message that describes what default value will be used if the user presses enter. This description appears in angle brackets <> in the command prompt window. You do not need to provide a default value description unless you explicity enable AcceptNothing.
(Inherited from GetBaseClass.)
Public methodSetDefaultColor
Sets a color as default value that will be returned if the user presses ENTER key during the get.
(Inherited from GetBaseClass.)
Public methodSetDefaultInteger
Sets a number as default value that will be returned if the user presses ENTER key during the get.
(Inherited from GetBaseClass.)
Public methodSetDefaultNumber
Sets a number as default value that will be returned if the user presses ENTER key during the get.
(Inherited from GetBaseClass.)
Public methodSetDefaultPoint
Sets a point as default value that will be returned if the user presses the ENTER key during the get.
(Inherited from GetBaseClass.)
Public methodCode exampleSetDefaultString
Sets a string as default value that will be returned if the user presses ENTER key during the get.
(Inherited from GetBaseClass.)
Public methodSetWaitDuration
Sets the wait duration (in milliseconds) of the getter. If the duration passes without the user making a decision, the GetResult.Timeout code is returned.
(Inherited from GetBaseClass.)
Public methodCode exampleStringResult
Gets a string if GetPoint.Get(), GetObject.GetObjects(), etc., returns GetResult.String.
(Inherited from GetBaseClass.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodTryGetBasePoint (Inherited from GetPoint.)
Public methodVector
Gets a direction if Get*() returns GetResult.Point (Set by some digitizers, but in general it's (0,0,0).
(Inherited from GetBaseClass.)
Public methodCode exampleView
Gets a view the user clicked in during GetPoint.Get(), GetObject.GetObjects(), etc.
(Inherited from GetBaseClass.)
Top
See Also