RhinoCommon API
ObjectTableAddPictureFrame Method |
Creates a PictureFrame object from a plane and a path to an image file,
Note, a PictureFrame object is just a Plane surface or mesh that has a
material with a texture assigned to it that displays in all display
modes.
Namespace: Rhino.DocObjects.Tables
Assembly: RhinoCommon (in RhinoCommon.dll)
public Guid AddPictureFrame( Plane plane, string texturePath, bool asMesh, double width, double height, bool selfIllumination, bool embedBitmap )
Public Function AddPictureFrame ( plane As Plane, texturePath As String, asMesh As Boolean, width As Double, height As Double, selfIllumination As Boolean, embedBitmap As Boolean ) As Guid
Parameters
- plane
- Type: Rhino.GeometryPlane
Plane in which the PictureFrame will be created. Bottom left corner of picture will be at plane's origin, width will be in the plane's x axis direction, height will be in the plane's y axis direction. - texturePath
- Type: SystemString
path to an image file - asMesh
- Type: SystemBoolean
If true, the function will make a MeshObject rather than a surface - width
- Type: SystemDouble
Width of the resulting PictureFrame. If 0.0, the width of the pictureframe is the width of the image if height is also 0.0 or calculated from the height and aspect ratio of the image if height is not 0.0. - height
- Type: SystemDouble
Height of the resulting PictureFrame. If 0.0, the height of the pictureframe is the height of the image if width is also 0.0 or calculated from the width and aspect ratio of the image if width is not 0.0. - selfIllumination
- Type: SystemBoolean
If true, the image mapped to the picture frame plane always displays at full intensity and is not affected by light or shadow. - embedBitmap
- Type: SystemBoolean
If true, the funtion adds the the image to the bitmaptable of the document to which the PictureFrame will be added
Return Value
Type: GuidA unique identifier for the object