The cl-ply Reference Manual

This is the cl-ply Reference Manual, version 0.1, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 11:19:10 2018 GMT+0.

1 Introduction

Cl-Ply

Cl-ply is a library to handle PLY format which is also known as the Stanford Triangle Format.

Example

Here shows hot to read PLY file with cl-ply.

The following is an example PLY file:

ply
format ascii 1.0
comment this is test ply data.
element vertex 2
property float x
property float y
property float z
element face 2
property list uchar int vertex_indices
end_header
0.0 1.0 2.0
3.0 4.0 5.0
4 0 1 2 3
4 4 5 6 7

It contains two elements, vertex that has three float properties and face that has a list property of integer.

You can read the PLY file as following:

;; open a PLY file, closed automatically when control leaves
(cl-ply:with-ply-for-reading (plyfile #P"/path/to/file.ply")
  ;; read and print vertex elements
  (loop repeat (cl-ply:ply-element-size plyfile "vertex")
     do (format t "element vertex ~S~%"
         (cl-ply:ply-read-element plyfile "vertex")))
  ;; read and print face elements
  (loop repeat (cl-ply:ply-element-size plyfile "face")
     do (format t "element face ~S~%"
         (cl-ply:ply-read-element plyfile "face"))))

Installation

Cl-ply can be installed via Quicklisp.

(ql:quickload :cl-ply)

API

[Macro] with-ply-for-reading

WITH-PLY-FOR-READING (var filespec) form* => results

Opens a file stream named by filespec and creates a plyfile object, reading PLY headers from the file. The plyfile object is bound to var. with-ply evaluates form as an implicit progn with var and returns the result values. When control leaves the forms, either normally and abnormally, the file stream is automatically closed.

[Function] ply-open-for-reading

OPEN-PLY-FOR-READING filespec => plyfile

Opens a file stream named by filespec, creates a plyfile object and returns it. The plyfile object should be closed after its use.

[Function] ply-close

PLY-CLOSE plyfile => result

Closes the plyfile object plyfile. The return value is that of standard's close function.

[Function] ply-element-names

PLY-ELEMENT-NAMES plyfile => element-names

Returns all names of elements in plyfile.

[Function] ply-element-size

PLY-ELEMENT-SIZE plyfile element-name => size

Returns the number of elements named by element-name in plyfile.

[Function] ply-read-element

PLY-READ-ELEMENT plyfile element-name => result

Reads an element of element-name from plyfile and returns as a list of its properties.

[Function] ply-comments

PLY-COMMENTS plyfile => comments

Returns a list of comments in plyfile.

[Function] ply-obj-info

PLY-OBJ-INFO plyfile => obj_info

Returns object information in plyfile.

FAQ

Q. Does cl-ply support writing PLY format?

A. No. Currenly, only reading PLY format is supported.

Q. Does cl-ply support reading / writing PLY format in binary type?

A. No. Currently, only ASCII type is supported.

Reference

PLY - Polygon File Format

Author

Masayuki Takagi (kamonama@gmail.com)

Copyright

License

Licensed under the LLGPL License.

2 Systems

The main system appears first, followed by any subsystem dependency.

2.1 `cl-ply`

Author

Masayuki Takagi

License

LLGPL

Description

Cl-ply is a library to handle PLY format which is also known as the Stanford Triangle Format.

Long Description

# Cl-Ply

[![Build Status](https://travis-ci.org/takagi/cl-ply.svg?branch=master)](https://travis-ci.org/takagi/cl-ply)
[![Coverage Status](https://coveralls.io/repos/takagi/cl-ply/badge.svg)](https://coveralls.io/r/takagi/cl-ply)

Cl-ply is a library to handle PLY format which is also known as the Stanford Triangle Format.

## Example

Here shows hot to read PLY file with cl-ply.

The following is an example PLY file:

ply
format ascii 1.0
comment this is test ply data.
element vertex 2
property float x
property float y
property float z
element face 2
property list uchar int vertex_indices
end_header
0.0 1.0 2.0
3.0 4.0 5.0
4 0 1 2 3
4 4 5 6 7

It contains two elements, ‘vertex‘ that has three float properties and ‘face‘ that has a list property of integer.

You can read the PLY file as following:

;; open a PLY file, closed automatically when control leaves
(cl-ply:with-ply-for-reading (plyfile #P"/path/to/file.ply")
;; read and print vertex elements
(loop repeat (cl-ply:ply-element-size plyfile "vertex")
do (format t "element vertex ~S~%"
(cl-ply:ply-read-element plyfile "vertex")))
;; read and print face elements
(loop repeat (cl-ply:ply-element-size plyfile "face")
do (format t "element face ~S~%"
(cl-ply:ply-read-element plyfile "face"))))

## Installation

Cl-ply can be installed via Quicklisp.

(ql:quickload :cl-ply)

## API

### [Macro] with-ply-for-reading

WITH-PLY-FOR-READING (var filespec) form* => results

Opens a file stream named by ‘filespec‘ and creates a plyfile object, reading PLY headers from the file. The plyfile object is bound to ‘var‘. ‘with-ply‘ evaluates ‘form‘ as an implicit progn with ‘var‘ and returns the result values. When control leaves the forms, either normally and abnormally, the file stream is automatically closed.

### [Function] ply-open-for-reading

OPEN-PLY-FOR-READING filespec => plyfile

Opens a file stream named by ‘filespec‘, creates a plyfile object and returns it. The plyfile object should be closed after its use.

### [Function] ply-close

PLY-CLOSE plyfile => result

Closes the plyfile object ‘plyfile‘. The return value is that of standard’s ‘close‘ function.

### [Function] ply-element-names

PLY-ELEMENT-NAMES plyfile => element-names

Returns all names of elements in ‘plyfile‘.

### [Function] ply-element-size

PLY-ELEMENT-SIZE plyfile element-name => size

Returns the number of elements named by ‘element-name‘ in ‘plyfile‘.

### [Function] ply-read-element

PLY-READ-ELEMENT plyfile element-name => result

Reads an element of ‘element-name‘ from ‘plyfile‘ and returns as a list of its properties.

### [Function] ply-comments

PLY-COMMENTS plyfile => comments

Returns a list of comments in ‘plyfile‘.

### [Function] ply-obj-info

PLY-OBJ-INFO plyfile => obj_info

Returns object information in ‘plyfile‘.

## FAQ

**Q. Does cl-ply support writing PLY format?**

A. No. Currenly, only reading PLY format is supported.

**Q. Does cl-ply support reading / writing PLY format in binary type?**

A. No. Currently, only ASCII type is supported.

## Reference

* [PLY - Polygon File Format](http://paulbourke.net/dataformats/ply/)

## Author

* Masayuki Takagi (kamonama@gmail.com)

## Copyright

## License

Licensed under the LLGPL License.

Version

0.1

Dependencies

cl-ppcre
cl-pattern

Source

cl-ply.asd (file)

Component

src (module)

3 Modules

Modules are listed depth-first from the system components tree.

3.1 `cl-ply/src`

Parent: cl-ply (system)
Location: src/
Component: cl-ply.lisp (file)

4 Files

Files are sorted by type and then listed depth-first from the systems components trees.

4.1 Lisp

4.1.1 `cl-ply.asd`

Location: cl-ply.asd
Systems: cl-ply (system)
Packages: cl-ply-asd

4.1.2 `cl-ply/src/cl-ply.lisp`

Parent

src (module)

Location

src/cl-ply.lisp

Packages

cl-ply

Exported Definitions

ply-close (function)
ply-comments (function)
ply-element-names (function)
ply-element-size (function)
ply-obj-info (function)
ply-open-for-reading (function)
ply-read-element (function)
with-ply-for-reading (macro)

Internal Definitions

%make-comment (function)
%make-element (function)
%make-list-property (function)
%make-obj-info (function)
%make-plyfile (function)
%make-scalar-property (function)
+ply-file-types+ (special variable)
+ply-types+ (special variable)
comment (structure)
comment-header-p (function)
comment-p (function)
comment-text (function)
copy-comment (function)
copy-element (function)
copy-list-property (function)
copy-obj-info (function)
copy-plyfile (function)
copy-scalar-property (function)
element (structure)
element-add-property (function)
element-header-p (function)
element-name (function)
element-p (function)
element-properties (function)
(setf element-properties) (function)
element-size (function)
end-header-p (function)
format-header-p (function)
header-kind (function)
list-property (structure)
list-property-count-type (function)
list-property-element-type (function)
list-property-name (function)
list-property-p (function)
make-comment (function)
make-element (function)
make-obj-info (function)
make-plyfile (function)
make-property (function)
obj-info (structure)
obj-info-header-p (function)
obj-info-p (function)
obj-info-text (function)
parse-comment-header (function)
parse-double-float (function)
parse-element-header (function)
parse-end-header (function)
parse-format-header (function)
parse-header (function)
parse-integer% (function)
parse-obj-info-header (function)
parse-ply-file-type (function)
parse-ply-header (function)
parse-ply-type (function)
parse-property-header (function)
parse-single-float (function)
parse-unsigned-integer (function)
parse-value (function)
ply-header-p (function)
plyfile (structure)
plyfile-add-comment (function)
plyfile-add-element (function)
plyfile-add-obj-info (function)
plyfile-add-property (function)
plyfile-comments (function)
(setf plyfile-comments) (function)
plyfile-element-by-name (function)
plyfile-elements (function)
(setf plyfile-elements) (function)
plyfile-file-type (function)
(setf plyfile-file-type) (function)
plyfile-obj-info (function)
(setf plyfile-obj-info) (function)
plyfile-p (function)
plyfile-set-format (function)
plyfile-stream (function)
plyfile-version (function)
(setf plyfile-version) (function)
property (type)
property-header-p (function)
read-element (function)
read-element-ascii (function)
read-element-big-endian (function)
read-element-little-endian (function)
read-header (function)
scalar-property (structure)
scalar-property-name (function)
scalar-property-p (function)
scalar-property-type (function)

5 Packages

Packages are listed by definition order.

5.1 `cl-ply-asd`

Source

cl-ply.asd

Use List

asdf/interface
common-lisp

5.2 `cl-ply`

Source

cl-ply.lisp (file)

Use List

common-lisp

Exported Definitions

ply-close (function)
ply-comments (function)
ply-element-names (function)
ply-element-size (function)
ply-obj-info (function)
ply-open-for-reading (function)
ply-read-element (function)
with-ply-for-reading (macro)

Internal Definitions

%make-comment (function)
%make-element (function)
%make-list-property (function)
%make-obj-info (function)
%make-plyfile (function)
%make-scalar-property (function)
+ply-file-types+ (special variable)
+ply-types+ (special variable)
comment (structure)
comment-header-p (function)
comment-p (function)
comment-text (function)
copy-comment (function)
copy-element (function)
copy-list-property (function)
copy-obj-info (function)
copy-plyfile (function)
copy-scalar-property (function)
element (structure)
element-add-property (function)
element-header-p (function)
element-name (function)
element-p (function)
element-properties (function)
(setf element-properties) (function)
element-size (function)
end-header-p (function)
format-header-p (function)
header-kind (function)
list-property (structure)
list-property-count-type (function)
list-property-element-type (function)
list-property-name (function)
list-property-p (function)
make-comment (function)
make-element (function)
make-obj-info (function)
make-plyfile (function)
make-property (function)
obj-info (structure)
obj-info-header-p (function)
obj-info-p (function)
obj-info-text (function)
parse-comment-header (function)
parse-double-float (function)
parse-element-header (function)
parse-end-header (function)
parse-format-header (function)
parse-header (function)
parse-integer% (function)
parse-obj-info-header (function)
parse-ply-file-type (function)
parse-ply-header (function)
parse-ply-type (function)
parse-property-header (function)
parse-single-float (function)
parse-unsigned-integer (function)
parse-value (function)
ply-header-p (function)
plyfile (structure)
plyfile-add-comment (function)
plyfile-add-element (function)
plyfile-add-obj-info (function)
plyfile-add-property (function)
plyfile-comments (function)
(setf plyfile-comments) (function)
plyfile-element-by-name (function)
plyfile-elements (function)
(setf plyfile-elements) (function)
plyfile-file-type (function)
(setf plyfile-file-type) (function)
plyfile-obj-info (function)
(setf plyfile-obj-info) (function)
plyfile-p (function)
plyfile-set-format (function)
plyfile-stream (function)
plyfile-version (function)
(setf plyfile-version) (function)
property (type)
property-header-p (function)
read-element (function)
read-element-ascii (function)
read-element-big-endian (function)
read-element-little-endian (function)
read-header (function)
scalar-property (structure)
scalar-property-name (function)
scalar-property-p (function)
scalar-property-type (function)

6 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.

6.1 Exported definitions

6.1.1 Macros

Macro: with-ply-for-reading (VAR FILESPEC) &body BODY

Package: cl-ply
Source: cl-ply.lisp (file)

6.1.2 Functions

Function: ply-close PLYFILE

Package: cl-ply
Source: cl-ply.lisp (file)

Function: ply-comments PLYFILE

Package: cl-ply
Source: cl-ply.lisp (file)

Function: ply-element-names PLYFILE

Package: cl-ply
Source: cl-ply.lisp (file)

Function: ply-element-size PLYFILE ELEMENT-NAME

Package: cl-ply
Source: cl-ply.lisp (file)

Function: ply-obj-info PLYFILE

Package: cl-ply
Source: cl-ply.lisp (file)

Function: ply-open-for-reading FILESPEC

Package: cl-ply
Source: cl-ply.lisp (file)

Function: ply-read-element PLYFILE ELEMENT-NAME

Package: cl-ply
Source: cl-ply.lisp (file)

6.2 Internal definitions

6.2.1 Special variables

Special Variable: +ply-file-types+

Package: cl-ply
Source: cl-ply.lisp (file)

Special Variable: +ply-types+

Package: cl-ply
Source: cl-ply.lisp (file)

6.2.2 Functions

Function: %make-comment &key (TEXT TEXT)

Package: cl-ply
Source: cl-ply.lisp (file)

Function: %make-element &key (NAME NAME) (SIZE SIZE) (PROPERTIES PROPERTIES)

Package: cl-ply
Source: cl-ply.lisp (file)

Function: %make-list-property &key (COUNT-TYPE COUNT-TYPE) (ELEMENT-TYPE ELEMENT-TYPE) (NAME NAME)

Package: cl-ply
Source: cl-ply.lisp (file)

Function: %make-obj-info &key (TEXT TEXT)

Package: cl-ply
Source: cl-ply.lisp (file)

Function: %make-plyfile &key (STREAM STREAM) (FILE-TYPE FILE-TYPE) (VERSION VERSION) (ELEMENTS ELEMENTS) (COMMENTS COMMENTS) (OBJ-INFO OBJ-INFO)

Package: cl-ply
Source: cl-ply.lisp (file)

Function: %make-scalar-property &key (TYPE TYPE) (NAME NAME)

Package: cl-ply
Source: cl-ply.lisp (file)

Function: comment-header-p OBJECT

Package: cl-ply
Source: cl-ply.lisp (file)

Function: comment-p OBJECT

Package: cl-ply
Source: cl-ply.lisp (file)

Function: comment-text INSTANCE

Package: cl-ply
Source: cl-ply.lisp (file)

Function: copy-comment INSTANCE

Package: cl-ply
Source: cl-ply.lisp (file)

Function: copy-element INSTANCE

Package: cl-ply
Source: cl-ply.lisp (file)

Function: copy-list-property INSTANCE

Package: cl-ply
Source: cl-ply.lisp (file)

Function: copy-obj-info INSTANCE

Package: cl-ply
Source: cl-ply.lisp (file)

Function: copy-plyfile INSTANCE

Package: cl-ply
Source: cl-ply.lisp (file)

Function: copy-scalar-property INSTANCE

Package: cl-ply
Source: cl-ply.lisp (file)

Function: element-add-property ELEMENT PROPERTY

Package: cl-ply
Source: cl-ply.lisp (file)

Function: element-header-p OBJECT

Package: cl-ply
Source: cl-ply.lisp (file)

Function: element-name INSTANCE

Package: cl-ply
Source: cl-ply.lisp (file)

Function: element-p OBJECT

Package: cl-ply
Source: cl-ply.lisp (file)

Function: element-properties INSTANCE

Function: (setf element-properties) VALUE INSTANCE

Package: cl-ply
Source: cl-ply.lisp (file)

Function: element-size INSTANCE

Package: cl-ply
Source: cl-ply.lisp (file)

Function: end-header-p OBJECT

Package: cl-ply
Source: cl-ply.lisp (file)

Function: format-header-p OBJECT

Package: cl-ply
Source: cl-ply.lisp (file)

Function: header-kind OBJECT

Package: cl-ply
Source: cl-ply.lisp (file)

Function: list-property-count-type INSTANCE

Package: cl-ply
Source: cl-ply.lisp (file)

Function: list-property-element-type INSTANCE

Package: cl-ply
Source: cl-ply.lisp (file)

Function: list-property-name INSTANCE

Package: cl-ply
Source: cl-ply.lisp (file)

Function: list-property-p OBJECT

Package: cl-ply
Source: cl-ply.lisp (file)

Function: make-comment HEADER

Package: cl-ply
Source: cl-ply.lisp (file)

Function: make-element HEADER

Package: cl-ply
Source: cl-ply.lisp (file)

Function: make-obj-info HEADER

Package: cl-ply
Source: cl-ply.lisp (file)

Function: make-plyfile STREAM

Package: cl-ply
Source: cl-ply.lisp (file)

Function: make-property HEADER

Package: cl-ply
Source: cl-ply.lisp (file)

Function: obj-info-header-p OBJECT

Package: cl-ply
Source: cl-ply.lisp (file)

Function: obj-info-p OBJECT

Package: cl-ply
Source: cl-ply.lisp (file)

Function: obj-info-text INSTANCE

Package: cl-ply
Source: cl-ply.lisp (file)

Function: parse-comment-header LINE

Package: cl-ply
Source: cl-ply.lisp (file)

Function: parse-double-float STRING

Package: cl-ply
Source: cl-ply.lisp (file)

Function: parse-element-header LINE

Package: cl-ply
Source: cl-ply.lisp (file)

Function: parse-end-header LINE

Package: cl-ply
Source: cl-ply.lisp (file)

Function: parse-format-header LINE

Package: cl-ply
Source: cl-ply.lisp (file)

Function: parse-header LINE

Package: cl-ply
Source: cl-ply.lisp (file)

Function: parse-integer% STRING

Package: cl-ply
Source: cl-ply.lisp (file)

Function: parse-obj-info-header LINE

Package: cl-ply
Source: cl-ply.lisp (file)

Function: parse-ply-file-type STRING

Package: cl-ply
Source: cl-ply.lisp (file)

Function: parse-ply-header LINE

Package: cl-ply
Source: cl-ply.lisp (file)

Function: parse-ply-type STRING

Package: cl-ply
Source: cl-ply.lisp (file)

Function: parse-property-header LINE

Package: cl-ply
Source: cl-ply.lisp (file)

Function: parse-single-float STRING

Package: cl-ply
Source: cl-ply.lisp (file)

Function: parse-unsigned-integer STRING

Package: cl-ply
Source: cl-ply.lisp (file)

Function: parse-value STRING PLY-TYPE

Package: cl-ply
Source: cl-ply.lisp (file)

Function: ply-header-p OBJECT

Package: cl-ply
Source: cl-ply.lisp (file)

Function: plyfile-add-comment PLYFILE COMMENT

Package: cl-ply
Source: cl-ply.lisp (file)

Function: plyfile-add-element PLYFILE ELEMENT

Package: cl-ply
Source: cl-ply.lisp (file)

Function: plyfile-add-obj-info PLYFILE OBJ-INFO

Package: cl-ply
Source: cl-ply.lisp (file)

Function: plyfile-add-property PLYFILE PROPERTY

Package: cl-ply
Source: cl-ply.lisp (file)

Function: plyfile-comments INSTANCE

Function: (setf plyfile-comments) VALUE INSTANCE

Package: cl-ply
Source: cl-ply.lisp (file)

Function: plyfile-element-by-name PLYFILE ELEMENT-NAME

Package: cl-ply
Source: cl-ply.lisp (file)

Function: plyfile-elements INSTANCE

Function: (setf plyfile-elements) VALUE INSTANCE

Package: cl-ply
Source: cl-ply.lisp (file)

Function: plyfile-file-type INSTANCE

Function: (setf plyfile-file-type) VALUE INSTANCE

Package: cl-ply
Source: cl-ply.lisp (file)

Function: plyfile-obj-info INSTANCE

Function: (setf plyfile-obj-info) VALUE INSTANCE

Package: cl-ply
Source: cl-ply.lisp (file)

Function: plyfile-p OBJECT

Package: cl-ply
Source: cl-ply.lisp (file)

Function: plyfile-set-format PLYFILE HEADER

Package: cl-ply
Source: cl-ply.lisp (file)

Function: plyfile-stream INSTANCE

Package: cl-ply
Source: cl-ply.lisp (file)

Function: plyfile-version INSTANCE

Function: (setf plyfile-version) VALUE INSTANCE

Package: cl-ply
Source: cl-ply.lisp (file)

Function: property-header-p OBJECT

Package: cl-ply
Source: cl-ply.lisp (file)

Function: read-element STREAM FILE-TYPE ELEMENT

Package: cl-ply
Source: cl-ply.lisp (file)

Function: read-element-ascii STREAM ELEMENT

Package: cl-ply
Source: cl-ply.lisp (file)

Function: read-element-big-endian STREAM TYPE

Package: cl-ply
Source: cl-ply.lisp (file)

Function: read-element-little-endian STREAM TYPE

Package: cl-ply
Source: cl-ply.lisp (file)

Function: read-header STREAM

Package: cl-ply
Source: cl-ply.lisp (file)

Function: scalar-property-name INSTANCE

Package: cl-ply
Source: cl-ply.lisp (file)

Function: scalar-property-p OBJECT

Package: cl-ply
Source: cl-ply.lisp (file)

Function: scalar-property-type INSTANCE

Package: cl-ply
Source: cl-ply.lisp (file)

6.2.3 Structures

Structure: comment ()

Package

cl-ply

Source

cl-ply.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots

Slot: text

Initform: :text
Readers: comment-text (function)
Writers: (setf comment-text) (function)

Structure: element ()

Package

cl-ply

Source

cl-ply.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots

Slot: name

Initform: :name
Readers: element-name (function)
Writers: (setf element-name) (function)

Slot: size

Initform: :size
Readers: element-size (function)
Writers: (setf element-size) (function)

Slot: properties

Readers: element-properties (function)
Writers: (setf element-properties) (function)

Structure: list-property ()

Package

cl-ply

Source

cl-ply.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots

Slot: count-type

Initform: :count-type
Readers: list-property-count-type (function)
Writers: (setf list-property-count-type) (function)

Slot: element-type

Initform: :element-type
Readers: list-property-element-type (function)
Writers: (setf list-property-element-type) (function)

Slot: name

Initform: :name
Readers: list-property-name (function)
Writers: (setf list-property-name) (function)

Structure: obj-info ()

Package

cl-ply

Source

cl-ply.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots

Slot: text

Initform: :text
Readers: obj-info-text (function)
Writers: (setf obj-info-text) (function)

Structure: plyfile ()

Package

cl-ply

Source

cl-ply.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots

Slot: stream

Readers: plyfile-stream (function)
Writers: (setf plyfile-stream) (function)

Slot: file-type

Readers: plyfile-file-type (function)
Writers: (setf plyfile-file-type) (function)

Slot: version

Readers: plyfile-version (function)
Writers: (setf plyfile-version) (function)

Slot: elements

Readers: plyfile-elements (function)
Writers: (setf plyfile-elements) (function)

Slot: comments

Readers: plyfile-comments (function)
Writers: (setf plyfile-comments) (function)

Slot: obj-info

Readers: plyfile-obj-info (function)
Writers: (setf plyfile-obj-info) (function)

Structure: scalar-property ()

Package

cl-ply

Source

cl-ply.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots

Slot: type

Initform: :type
Readers: scalar-property-type (function)
Writers: (setf scalar-property-type) (function)

Slot: name

Initform: :name
Readers: scalar-property-name (function)
Writers: (setf scalar-property-name) (function)

6.2.4 Types

Type: property ()

Package: cl-ply
Source: cl-ply.lisp (file)

Appendix A Indexes

A.1 Concepts

Jump to:	C F L M

	Index Entry	Section

C
	`cl-ply.asd`:	The cl-ply<dot>asd file
	`cl-ply/src`:	The cl-ply/src module
	`cl-ply/src/cl-ply.lisp`:	The cl-ply/src/cl-ply<dot>lisp file

F
	File, Lisp, `cl-ply.asd`:	The cl-ply<dot>asd file
	File, Lisp, `cl-ply/src/cl-ply.lisp`:	The cl-ply/src/cl-ply<dot>lisp file

L
	Lisp File, `cl-ply.asd`:	The cl-ply<dot>asd file
	Lisp File, `cl-ply/src/cl-ply.lisp`:	The cl-ply/src/cl-ply<dot>lisp file

M
	Module, `cl-ply/src`:	The cl-ply/src module

Jump to:	C F L M

A.2 Functions

Jump to:	% ( C E F H L M O P R S W

	Index Entry	Section

%
	`%make-comment`:	Internal functions
	`%make-element`:	Internal functions
	`%make-list-property`:	Internal functions
	`%make-obj-info`:	Internal functions
	`%make-plyfile`:	Internal functions
	`%make-scalar-property`:	Internal functions

(
	`(setf element-properties)`:	Internal functions
	`(setf plyfile-comments)`:	Internal functions
	`(setf plyfile-elements)`:	Internal functions
	`(setf plyfile-file-type)`:	Internal functions
	`(setf plyfile-obj-info)`:	Internal functions
	`(setf plyfile-version)`:	Internal functions

C
	`comment-header-p`:	Internal functions
	`comment-p`:	Internal functions
	`comment-text`:	Internal functions
	`copy-comment`:	Internal functions
	`copy-element`:	Internal functions
	`copy-list-property`:	Internal functions
	`copy-obj-info`:	Internal functions
	`copy-plyfile`:	Internal functions
	`copy-scalar-property`:	Internal functions

E
	`element-add-property`:	Internal functions
	`element-header-p`:	Internal functions
	`element-name`:	Internal functions
	`element-p`:	Internal functions
	`element-properties`:	Internal functions
	`element-size`:	Internal functions
	`end-header-p`:	Internal functions

F
	`format-header-p`:	Internal functions
	`Function, %make-comment`:	Internal functions
	`Function, %make-element`:	Internal functions
	`Function, %make-list-property`:	Internal functions
	`Function, %make-obj-info`:	Internal functions
	`Function, %make-plyfile`:	Internal functions
	`Function, %make-scalar-property`:	Internal functions
	`Function, (setf element-properties)`:	Internal functions
	`Function, (setf plyfile-comments)`:	Internal functions
	`Function, (setf plyfile-elements)`:	Internal functions
	`Function, (setf plyfile-file-type)`:	Internal functions
	`Function, (setf plyfile-obj-info)`:	Internal functions
	`Function, (setf plyfile-version)`:	Internal functions
	`Function, comment-header-p`:	Internal functions
	`Function, comment-p`:	Internal functions
	`Function, comment-text`:	Internal functions
	`Function, copy-comment`:	Internal functions
	`Function, copy-element`:	Internal functions
	`Function, copy-list-property`:	Internal functions
	`Function, copy-obj-info`:	Internal functions
	`Function, copy-plyfile`:	Internal functions
	`Function, copy-scalar-property`:	Internal functions
	`Function, element-add-property`:	Internal functions
	`Function, element-header-p`:	Internal functions
	`Function, element-name`:	Internal functions
	`Function, element-p`:	Internal functions
	`Function, element-properties`:	Internal functions
	`Function, element-size`:	Internal functions
	`Function, end-header-p`:	Internal functions
	`Function, format-header-p`:	Internal functions
	`Function, header-kind`:	Internal functions
	`Function, list-property-count-type`:	Internal functions
	`Function, list-property-element-type`:	Internal functions
	`Function, list-property-name`:	Internal functions
	`Function, list-property-p`:	Internal functions
	`Function, make-comment`:	Internal functions
	`Function, make-element`:	Internal functions
	`Function, make-obj-info`:	Internal functions
	`Function, make-plyfile`:	Internal functions
	`Function, make-property`:	Internal functions
	`Function, obj-info-header-p`:	Internal functions
	`Function, obj-info-p`:	Internal functions
	`Function, obj-info-text`:	Internal functions
	`Function, parse-comment-header`:	Internal functions
	`Function, parse-double-float`:	Internal functions
	`Function, parse-element-header`:	Internal functions
	`Function, parse-end-header`:	Internal functions
	`Function, parse-format-header`:	Internal functions
	`Function, parse-header`:	Internal functions
	`Function, parse-integer%`:	Internal functions
	`Function, parse-obj-info-header`:	Internal functions
	`Function, parse-ply-file-type`:	Internal functions
	`Function, parse-ply-header`:	Internal functions
	`Function, parse-ply-type`:	Internal functions
	`Function, parse-property-header`:	Internal functions
	`Function, parse-single-float`:	Internal functions
	`Function, parse-unsigned-integer`:	Internal functions
	`Function, parse-value`:	Internal functions
	`Function, ply-close`:	Exported functions
	`Function, ply-comments`:	Exported functions
	`Function, ply-element-names`:	Exported functions
	`Function, ply-element-size`:	Exported functions
	`Function, ply-header-p`:	Internal functions
	`Function, ply-obj-info`:	Exported functions
	`Function, ply-open-for-reading`:	Exported functions
	`Function, ply-read-element`:	Exported functions
	`Function, plyfile-add-comment`:	Internal functions
	`Function, plyfile-add-element`:	Internal functions
	`Function, plyfile-add-obj-info`:	Internal functions
	`Function, plyfile-add-property`:	Internal functions
	`Function, plyfile-comments`:	Internal functions
	`Function, plyfile-element-by-name`:	Internal functions
	`Function, plyfile-elements`:	Internal functions
	`Function, plyfile-file-type`:	Internal functions
	`Function, plyfile-obj-info`:	Internal functions
	`Function, plyfile-p`:	Internal functions
	`Function, plyfile-set-format`:	Internal functions
	`Function, plyfile-stream`:	Internal functions
	`Function, plyfile-version`:	Internal functions
	`Function, property-header-p`:	Internal functions
	`Function, read-element`:	Internal functions
	`Function, read-element-ascii`:	Internal functions
	`Function, read-element-big-endian`:	Internal functions
	`Function, read-element-little-endian`:	Internal functions
	`Function, read-header`:	Internal functions
	`Function, scalar-property-name`:	Internal functions
	`Function, scalar-property-p`:	Internal functions
	`Function, scalar-property-type`:	Internal functions

H
	`header-kind`:	Internal functions

L
	`list-property-count-type`:	Internal functions
	`list-property-element-type`:	Internal functions
	`list-property-name`:	Internal functions
	`list-property-p`:	Internal functions

M
	`Macro, with-ply-for-reading`:	Exported macros
	`make-comment`:	Internal functions
	`make-element`:	Internal functions
	`make-obj-info`:	Internal functions
	`make-plyfile`:	Internal functions
	`make-property`:	Internal functions

O
	`obj-info-header-p`:	Internal functions
	`obj-info-p`:	Internal functions
	`obj-info-text`:	Internal functions

P
	`parse-comment-header`:	Internal functions
	`parse-double-float`:	Internal functions
	`parse-element-header`:	Internal functions
	`parse-end-header`:	Internal functions
	`parse-format-header`:	Internal functions
	`parse-header`:	Internal functions
	`parse-integer%`:	Internal functions
	`parse-obj-info-header`:	Internal functions
	`parse-ply-file-type`:	Internal functions
	`parse-ply-header`:	Internal functions
	`parse-ply-type`:	Internal functions
	`parse-property-header`:	Internal functions
	`parse-single-float`:	Internal functions
	`parse-unsigned-integer`:	Internal functions
	`parse-value`:	Internal functions
	`ply-close`:	Exported functions
	`ply-comments`:	Exported functions
	`ply-element-names`:	Exported functions
	`ply-element-size`:	Exported functions
	`ply-header-p`:	Internal functions
	`ply-obj-info`:	Exported functions
	`ply-open-for-reading`:	Exported functions
	`ply-read-element`:	Exported functions
	`plyfile-add-comment`:	Internal functions
	`plyfile-add-element`:	Internal functions
	`plyfile-add-obj-info`:	Internal functions
	`plyfile-add-property`:	Internal functions
	`plyfile-comments`:	Internal functions
	`plyfile-element-by-name`:	Internal functions
	`plyfile-elements`:	Internal functions
	`plyfile-file-type`:	Internal functions
	`plyfile-obj-info`:	Internal functions
	`plyfile-p`:	Internal functions
	`plyfile-set-format`:	Internal functions
	`plyfile-stream`:	Internal functions
	`plyfile-version`:	Internal functions
	`property-header-p`:	Internal functions

R
	`read-element`:	Internal functions
	`read-element-ascii`:	Internal functions
	`read-element-big-endian`:	Internal functions
	`read-element-little-endian`:	Internal functions
	`read-header`:	Internal functions

S
	`scalar-property-name`:	Internal functions
	`scalar-property-p`:	Internal functions
	`scalar-property-type`:	Internal functions

W
	`with-ply-for-reading`:	Exported macros

Jump to:	% ( C E F H L M O P R S W

A.3 Variables

Jump to:	+ C E F N O P S T V

	Index Entry	Section

+
	`+ply-file-types+`:	Internal special variables
	`+ply-types+`:	Internal special variables

C
	`comments`:	Internal structures
	`count-type`:	Internal structures

E
	`element-type`:	Internal structures
	`elements`:	Internal structures

F
	`file-type`:	Internal structures

N
	`name`:	Internal structures
	`name`:	Internal structures
	`name`:	Internal structures

O
	`obj-info`:	Internal structures

P
	`properties`:	Internal structures

S
	`size`:	Internal structures
	`Slot, comments`:	Internal structures
	`Slot, count-type`:	Internal structures
	`Slot, element-type`:	Internal structures
	`Slot, elements`:	Internal structures
	`Slot, file-type`:	Internal structures
	`Slot, name`:	Internal structures
	`Slot, name`:	Internal structures
	`Slot, name`:	Internal structures
	`Slot, obj-info`:	Internal structures
	`Slot, properties`:	Internal structures
	`Slot, size`:	Internal structures
	`Slot, stream`:	Internal structures
	`Slot, text`:	Internal structures
	`Slot, text`:	Internal structures
	`Slot, type`:	Internal structures
	`Slot, version`:	Internal structures
	`Special Variable, +ply-file-types+`:	Internal special variables
	`Special Variable, +ply-types+`:	Internal special variables
	`stream`:	Internal structures

T
	`text`:	Internal structures
	`text`:	Internal structures
	`type`:	Internal structures

V
	`version`:	Internal structures

Jump to:	+ C E F N O P S T V

A.4 Data types

Jump to:	C E L O P S T

	Index Entry	Section

C
	`cl-ply`:	The cl-ply system
	`cl-ply`:	The cl-ply package
	`cl-ply-asd`:	The cl-ply-asd package
	`comment`:	Internal structures

E
	`element`:	Internal structures

L
	`list-property`:	Internal structures

O
	`obj-info`:	Internal structures

P
	`Package, cl-ply`:	The cl-ply package
	`Package, cl-ply-asd`:	The cl-ply-asd package
	`plyfile`:	Internal structures
	`property`:	Internal types

S
	`scalar-property`:	Internal structures
	`Structure, comment`:	Internal structures
	`Structure, element`:	Internal structures
	`Structure, list-property`:	Internal structures
	`Structure, obj-info`:	Internal structures
	`Structure, plyfile`:	Internal structures
	`Structure, scalar-property`:	Internal structures
	`System, cl-ply`:	The cl-ply system

T
	`Type, property`:	Internal types

Jump to:	C E L O P S T

• Introduction:		What cl-ply is all about
• Systems:		The systems documentation
• Modules:		The modules documentation
• Files:		The files documentation
• Packages:		The packages documentation
• Definitions:		The symbols documentation
• Indexes:		Concepts, functions, variables and data types

• Internal special variables:
• Internal functions:
• Internal structures:
• Internal types:

• Concept index:
• Function index:
• Variable index:
• Data type index:

• The cl-ply.asd file:
• The cl-ply/src/cl-ply.lisp file:

The cl-ply Reference Manual

Table of Contents

The cl-ply Reference Manual

1 Introduction

Cl-Ply

Example

Installation

API

[Macro] with-ply-for-reading

[Function] ply-open-for-reading

[Function] ply-close

[Function] ply-element-names

[Function] ply-element-size

[Function] ply-read-element

[Function] ply-comments

[Function] ply-obj-info

FAQ

Reference

Author

Copyright

License

2 Systems

2.1 cl-ply

3 Modules

3.1 cl-ply/src

4 Files

4.1 Lisp

4.1.1 cl-ply.asd

4.1.2 cl-ply/src/cl-ply.lisp

5 Packages

5.1 cl-ply-asd

5.2 cl-ply

6 Definitions

6.1 Exported definitions

6.1.1 Macros

6.1.2 Functions

6.2 Internal definitions

6.2.1 Special variables

6.2.2 Functions

6.2.3 Structures

6.2.4 Types

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types

2.1 `cl-ply`

3.1 `cl-ply/src`

4.1.1 `cl-ply.asd`

4.1.2 `cl-ply/src/cl-ply.lisp`

5.1 `cl-ply-asd`

5.2 `cl-ply`