Table of Contents

Class RcsScanDocument

Namespace
PclIO.Formats.Recap
Assembly
PclIO.dll

Reads the header of a ReCap scan file (.rcs). Point decoding is experimental: only the node layout of major version 3 is supported, and any other layout is rejected instead of guessed.

public sealed class RcsScanDocument : PclDocument, IDisposable

Inheritance

Implements

Inherited Members

Properties

DeclaredPointCount

Point count declared in the header; it is not cross-checked against the node table.

public long DeclaredPointCount { get; }

Property Value

long

HasColorData

Always true: a constant of the supported layout, whose point record always has colour fields. It is not read from the file.

public bool HasColorData { get; }

Property Value

bool

HasIntensityData

Always true: a constant of the supported layout, whose point record always has an intensity field. It is not read from the file.

public bool HasIntensityData { get; }

Property Value

bool

HasNormalData

Always true: a constant of the supported layout, which can carry normals. It is not read from the file; each node decides whether its points have one, so single points may have none.

public bool HasNormalData { get; }

Property Value

bool

Kind

The format kind of this document.

public override PclFileKind Kind { get; }

Property Value

PclFileKind

LocalBounds

Local bounding box stored in the header.

public PclBounds LocalBounds { get; }

Property Value

PclBounds

MajorVersion

Container major version from the header.

public uint MajorVersion { get; }

Property Value

uint

MinorVersion

Container minor version from the header.

public uint MinorVersion { get; }

Property Value

uint

OctreeBounds

Octree bounding box stored in the header.

public PclBounds OctreeBounds { get; }

Property Value

PclBounds

ScanGuid

Scan identifier string stored in the header; may be empty.

public string ScanGuid { get; }

Property Value

string

ScanTransform

Header translation and scale (a zero scale component is read as 1). Rotation is parsed but not applied to points.

public PclTransform ScanTransform { get; }

Property Value

PclTransform

Scans

The scans contained in the document, in file order.

public override IReadOnlyList<PclScan> Scans { get; }

Property Value

IReadOnlyList<PclScan>

Methods

Open(string, PclReadOptions?)

Opens an .rcs file and parses its fixed-size header.

public static RcsScanDocument Open(string path, PclReadOptions? options = null)

Parameters

path string
options PclReadOptions?

Returns

RcsScanDocument

Exceptions

FileNotFoundException

The file does not exist.

InvalidDataException

The header is truncated or invalid.