> For the complete documentation index, see [llms.txt](https://docs.apryse.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.apryse.com/android/get-started/samples/u3dtest.md). # U3D Sample Kotlin code for using Apryse SDK to embed U3D content (3 dimensional models) in PDF files. Sample Kotlin code for using Apryse SDK to embed U3D content (3 dimensional models) in PDF files. Learn more about our [Android SDK](/android/guides.md). {% tabs %} {% tab title="Kotlin" %} {% code lineNumbers="true" %} ```kotlin //--------------------------------------------------------------------------------------- // Copyright (c) 2001-2019 by PDFTron Systems Inc. All Rights Reserved. // Consult legal.txt regarding legal and license information. //--------------------------------------------------------------------------------------- package com.pdftron.android.pdfnetsdksamples.samples import com.pdftron.android.pdfnetsdksamples.OutputListener import com.pdftron.android.pdfnetsdksamples.PDFNetSample import com.pdftron.android.pdfnetsdksamples.R import com.pdftron.android.pdfnetsdksamples.util.Utils import com.pdftron.common.PDFNetException import com.pdftron.filters.FilterReader import com.pdftron.filters.FlateEncode import com.pdftron.filters.MappedFile import com.pdftron.pdf.* import com.pdftron.sdf.Obj import com.pdftron.sdf.SDFDoc import java.util.* class U3DTest : PDFNetSample() { init { setTitle(R.string.sample_u3d_title) setDescription(R.string.sample_u3d_description) } override fun run(outputListener: OutputListener?) { super.run(outputListener) mOutputListener = outputListener mFileList.clear() printHeader(outputListener!!) try { PDFDoc().use { doc -> val page = doc.pageCreate() doc.pagePushBack(page) val annots = doc.createIndirectArray() page.sdfObj.put("Annots", annots) Create3DAnnotation(doc, annots) doc.save(Utils.createExternalFile("dice_u3d.pdf", mFileList).absolutePath, SDFDoc.SaveMode.LINEARIZED, null) mOutputListener!!.println("Done") } } catch (e: Exception) { mOutputListener!!.printError(e.stackTrace) } for (file in mFileList) { addToFileList(file) } printFooter(outputListener) } companion object { private var mOutputListener: OutputListener? = null private val mFileList = ArrayList() @Throws(PDFNetException::class) internal fun Create3DAnnotation(doc: PDFDoc, annots: Obj) { // --------------------------------------------------------------------------------- // Create a 3D annotation based on U3D content. PDF 1.6 introduces the capability // for collections of three-dimensional objects, such as those used by CAD software, // to be embedded in PDF files. val link_3D = doc.createIndirectDict() link_3D.putName("Subtype", "3D") // Annotation location on the page val link_3D_rect = Rect(25.0, 180.0, 585.0, 643.0) link_3D.putRect("Rect", link_3D_rect.x1, link_3D_rect.y1, link_3D_rect.x2, link_3D_rect.y2) annots.pushBack(link_3D) // The 3DA entry is an activation dictionary (see Table 9.34 in the PDF Reference Manual) // that determines how the state of the annotation and its associated artwork can change. val activation_dict_3D = link_3D.putDict("3DA") // Set the annotation so that it is activated as soon as the page containing the // annotation is opened. Other options are: PV (page view) and XA (explicit) activation. activation_dict_3D.putName("A", "PO") // Embed U3D Streams (3D Model/Artwork). run { val u3d_file = MappedFile(Utils.getAssetTempFile(PDFNetSample.INPUT_PATH + "dice.u3d")!!.absolutePath) val u3d_reader = FilterReader(u3d_file) // To embed 3D stream without compression, you can omit the second parameter in CreateIndirectStream. val u3d_data_dict = doc.createIndirectStream(u3d_reader, FlateEncode(null)) u3d_data_dict.putName("Subtype", "U3D") link_3D.put("3DD", u3d_data_dict) } // Set the initial view of the 3D artwork that should be used when the annotation is activated. val view3D_dict = link_3D.putDict("3DV") run { view3D_dict.putString("IN", "Unnamed") view3D_dict.putString("XN", "Default") view3D_dict.putName("MS", "M") view3D_dict.putNumber("CO", 27.5) // A 12-element 3D transformation matrix that specifies a position and orientation // of the camera in world coordinates. val tr3d = view3D_dict.putArray("C2W") tr3d.pushBackNumber(1.0) tr3d.pushBackNumber(0.0) tr3d.pushBackNumber(0.0) tr3d.pushBackNumber(0.0) tr3d.pushBackNumber(0.0) tr3d.pushBackNumber(-1.0) tr3d.pushBackNumber(0.0) tr3d.pushBackNumber(1.0) tr3d.pushBackNumber(0.0) tr3d.pushBackNumber(0.0) tr3d.pushBackNumber(-27.5) tr3d.pushBackNumber(0.0) } // Create annotation appearance stream, a thumbnail which is used during printing or // in PDF processors that do not understand 3D data. val ap_dict = link_3D.putDict("AP") run { val builder = ElementBuilder() val writer = ElementWriter() writer.begin(doc) val thumb_pathname = Utils.getAssetTempFile(PDFNetSample.INPUT_PATH + "dice.jpg")!!.absolutePath val image = Image.create(doc, thumb_pathname) writer.writePlacedElement(builder.createImage(image, 0.0, 0.0, link_3D_rect.width, link_3D_rect.height)) val normal_ap_stream = writer.end() normal_ap_stream.putName("Subtype", "Form") normal_ap_stream.putRect("BBox", 0.0, 0.0, link_3D_rect.width, link_3D_rect.height) ap_dict.put("N", normal_ap_stream) } } } } ``` {% endcode %} {% endtab %} {% tab title="Java" %} {% code lineNumbers="true" %} ```java //--------------------------------------------------------------------------------------- // Copyright (c) 2001-2019 by PDFTron Systems Inc. All Rights Reserved. // Consult legal.txt regarding legal and license information. //--------------------------------------------------------------------------------------- package com.pdftron.android.pdfnetsdksamples.samples; import com.pdftron.android.pdfnetsdksamples.OutputListener; import com.pdftron.android.pdfnetsdksamples.PDFNetSample; import com.pdftron.android.pdfnetsdksamples.R; import com.pdftron.android.pdfnetsdksamples.util.Utils; import com.pdftron.common.PDFNetException; import com.pdftron.filters.FilterReader; import com.pdftron.filters.FlateEncode; import com.pdftron.filters.MappedFile; import com.pdftron.pdf.ElementBuilder; import com.pdftron.pdf.ElementWriter; import com.pdftron.pdf.Image; import com.pdftron.pdf.PDFDoc; import com.pdftron.pdf.Page; import com.pdftron.pdf.Rect; import com.pdftron.sdf.Obj; import com.pdftron.sdf.SDFDoc; import java.util.ArrayList; public class U3DTest extends PDFNetSample { private static OutputListener mOutputListener; private static ArrayList mFileList = new ArrayList<>(); public U3DTest() { setTitle(R.string.sample_u3d_title); setDescription(R.string.sample_u3d_description); } @Override public void run(OutputListener outputListener) { super.run(outputListener); mOutputListener = outputListener; mFileList.clear(); printHeader(outputListener); try (PDFDoc doc = new PDFDoc()) { Page page = doc.pageCreate(); doc.pagePushBack(page); Obj annots = doc.createIndirectArray(); page.getSDFObj().put("Annots", annots); Create3DAnnotation(doc, annots); doc.save(Utils.createExternalFile("dice_u3d.pdf", mFileList).getAbsolutePath(), SDFDoc.SaveMode.LINEARIZED, null); mOutputListener.println("Done"); } catch (Exception e) { mOutputListener.printError(e.getStackTrace()); } for (String file : mFileList) { addToFileList(file); } printFooter(outputListener); } static void Create3DAnnotation(PDFDoc doc, Obj annots) throws PDFNetException { // --------------------------------------------------------------------------------- // Create a 3D annotation based on U3D content. PDF 1.6 introduces the capability // for collections of three-dimensional objects, such as those used by CAD software, // to be embedded in PDF files. Obj link_3D = doc.createIndirectDict(); link_3D.putName("Subtype", "3D"); // Annotation location on the page Rect link_3D_rect = new Rect(25, 180, 585, 643); link_3D.putRect("Rect", link_3D_rect.getX1(), link_3D_rect.getY1(), link_3D_rect.getX2(), link_3D_rect.getY2()); annots.pushBack(link_3D); // The 3DA entry is an activation dictionary (see Table 9.34 in the PDF Reference Manual) // that determines how the state of the annotation and its associated artwork can change. Obj activation_dict_3D = link_3D.putDict("3DA"); // Set the annotation so that it is activated as soon as the page containing the // annotation is opened. Other options are: PV (page view) and XA (explicit) activation. activation_dict_3D.putName("A", "PO"); // Embed U3D Streams (3D Model/Artwork). { MappedFile u3d_file = new MappedFile(Utils.getAssetTempFile(INPUT_PATH + "dice.u3d").getAbsolutePath()); FilterReader u3d_reader = new FilterReader(u3d_file); // To embed 3D stream without compression, you can omit the second parameter in CreateIndirectStream. Obj u3d_data_dict = doc.createIndirectStream(u3d_reader, new FlateEncode(null)); u3d_data_dict.putName("Subtype", "U3D"); link_3D.put("3DD", u3d_data_dict); } // Set the initial view of the 3D artwork that should be used when the annotation is activated. Obj view3D_dict = link_3D.putDict("3DV"); { view3D_dict.putString("IN", "Unnamed"); view3D_dict.putString("XN", "Default"); view3D_dict.putName("MS", "M"); view3D_dict.putNumber("CO", 27.5); // A 12-element 3D transformation matrix that specifies a position and orientation // of the camera in world coordinates. Obj tr3d = view3D_dict.putArray("C2W"); tr3d.pushBackNumber(1); tr3d.pushBackNumber(0); tr3d.pushBackNumber(0); tr3d.pushBackNumber(0); tr3d.pushBackNumber(0); tr3d.pushBackNumber(-1); tr3d.pushBackNumber(0); tr3d.pushBackNumber(1); tr3d.pushBackNumber(0); tr3d.pushBackNumber(0); tr3d.pushBackNumber(-27.5); tr3d.pushBackNumber(0); } // Create annotation appearance stream, a thumbnail which is used during printing or // in PDF processors that do not understand 3D data. Obj ap_dict = link_3D.putDict("AP"); { ElementBuilder builder = new ElementBuilder(); ElementWriter writer = new ElementWriter(); writer.begin(doc); String thumb_pathname = Utils.getAssetTempFile(INPUT_PATH + "dice.jpg").getAbsolutePath(); Image image = Image.create(doc, thumb_pathname); writer.writePlacedElement(builder.createImage(image, 0.0, 0.0, link_3D_rect.getWidth(), link_3D_rect.getHeight())); Obj normal_ap_stream = writer.end(); normal_ap_stream.putName("Subtype", "Form"); normal_ap_stream.putRect("BBox", 0, 0, link_3D_rect.getWidth(), link_3D_rect.getHeight()); ap_dict.put("N", normal_ap_stream); } } } ``` {% endcode %} {% endtab %} {% endtabs %} --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.apryse.com/android/get-started/samples/u3dtest.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.