A Face is a two-dimensional region defined by a collection of closed Wires. The geometry of a face can be flat or undulating. More...

#include <Face.h>

Inheritance diagram for Topologic::Face:

Public Member Functions
List< Edge^> ^	SharedEdges (Face^ face)
	Returns the shared Edges between two Faces. More...

List< Vertex^> ^	SharedVertices (Face^ face)
	Returns the shared Vertices between two Faces. More...

Face ^	AddInternalBoundaries (List< Wire^>^ internalBoundaries)
	Adds internal boundaries (Wires) to a Face. More...

Face ^	AddApertureDesign (Face^ apertureDesign, int numEdgeSamples)
	Adds an Aperture design to a Face. More...

Public Member Functions inherited from Topologic::Topology
Topology ^	AddContents (List< Topology^>^ contentTopologies, int typeFilter)
	Adds a list of Topologies as contents (non-constituent members) to another Topology of a specific type. If the type filter is 0, the contents will be added to the parent topology. Otherwise, the contents will be added to the closest sub-topology which matches the filter. More...

Topology ^	RemoveContent (Topology^ contentTopology)
	Removes a content (non-constituent member) from a Topology. More...

Topology ^	RemoveContents (List< Topology^>^ contentTopologies)
	Removes contents (non-constituent members) from a Topology. More...

Topology ^	AddApertures (System::Collections::Generic::IEnumerable< Topology^>^ apertureTopologies)
	Adds Apertures to a Topology. More...

List< Topology^> ^	SharedTopologies (Topology^ topology, int typeFilter)
	Returns the shared Topologies between the input Topology and another Topology. More...

Topology ^	Difference (Topology^ topology)
	Performs the Difference operation between the input Topology and another Topology. More...

Topology ^	Impose (Topologic::Topology^ tool)
	Imposes another Topology on the input Topology. More...

Topology ^	Imprint (Topology^ tool)
	Imprints another Topology on the input Topology. More...

Topology ^	Intersect (Topology^ topology)
	Performs the Intersection operation between the input Topology and another Topology. More...

Topology ^	Merge (Topology^ topology)
	Merges the input Topology and another Topology. More...

Topology ^	SelfMerge ()
	Merges the sub-topologies of the input Topology. More...

Topology ^	Slice (Topology^ tool)
	Slices the input Topology with another Topology. More...

Topology ^	Divide (Topology^ tool)
	Divides the input Topology with another Topology. More...

Topology ^	Union (Topology^ topology)
	Unions the input Topology and another Topology. More...

Topology ^	XOR (Topology^ topology)
	Performs an XOR operation between the input Topology and another Topology. More...

bool	ExportToBRep (String^ path)
	Exports a Topology to a BRep file (.brep). More...

String ^	Analyze ()
	Prints the topological information of a Topology. More...

bool	IsSame (Topology^ topology)
	Checks if two Topologies are the same. NOTE: This is a pointer check, not a topological or a geometry one. More...

Topology ^	ClosestSimplestSubshape (Topology^ selector)
	Returns the sub-topology that is the closest to the selector and the simplest (i.e. has the lowest dimensionality). More...

Topology ^	SelectSubtopology (Vertex^ selector, int typeFilter)
	Returns the sub-topology that is the closest to the selector Vertex and of a specific type. More...

Topology ^	ShallowCopy ()
	Copies a Topology without its contents. More...

Topology ^	SetDictionary (Dictionary< String^, Object^>^ dictionary)
	Sets a dictionary for a Topology. More...

Topology ^	SetDictionaries (List< Vertex^>^ selectors, List< Dictionary< String^, Object^>^>^ dictionaries, int typeFilter)
	Sets a list of dictionaries for a Topology. More...

Static Public Member Functions
static Face ^	ByWire (Wire^ wire)
	Creates a Face by a closed planar Wire. More...

static Face ^	ByExternalInternalBoundaries (Wire^ externalBoundary, System::Collections::Generic::IEnumerable< Wire^>^ internalBoundaries)
	Creates a Face by an external boundary (Wire) and internal boundaries (Wires). More...

static Face ^	ByNurbsParameters (List< List< Vertex^>^>^ controlPoints, List< List< double >^>^ weights, List< double >^ uKnots, List< double >^ vKnots, bool isRational, bool isUPeriodic, bool isVPeriodic, int uDegree, int vDegree)

static Face ^	ByEdges (System::Collections::Generic::IEnumerable< Edge^>^ edges)
	Creates a Face by a list of Edges. More...

static int	Type ()
	Returns the type associated to Face. More...

Static Public Member Functions inherited from Topologic::Topology
static List< Topology^> ^	ByVerticesIndices (System::Collections::Generic::IEnumerable< Vertex^>^ vertices, System::Collections::Generic::IEnumerable< System::Collections::Generic::List< int >^>^ vertexIndices)
	Creates a Topology by a list of Vertices and a 2D list of indices of the Vertices in the first argument. An array of 1 index makes a Vertex. An array of 2 indices makes an Edge. An array of 3 indices either makes a Wire, or, when the array has at least 4 vertices and the first index is the same as the last index, a Face will be created instead. NOTE: This node currently can only create planar Faces. More...

static Topology ^	ByImportedBRep (String^ path)
	Imports a Topology from a BRep file (.brep). More...

static List< Topology^> ^	Filter (List< Topology^>^ topologies, int typeFilter)
	Filters a list of Topologies by type. This methods returns a list of Topologies of the type specified in the typefilter. More...

Protected Member Functions
	Face (const std::shared_ptr< TopologicCore::Face > &kpCoreFace)

virtual std::shared_ptr< TopologicCore::TopologicalQuery >	GetCoreTopologicalQuery () override

Object ^	Surface ()

NurbsSurface ^	Surface (Handle(Geom_BSplineSurface) pOcctBSplineSurface)

PlanarSurface ^	Surface (Handle(Geom_Plane) pOcctPlane)

Protected Member Functions inherited from Topologic::Topology
Object ^	CleanupGeometryOutput (List< Object^>^ geometry)

Protected Attributes
std::shared_ptr< TopologicCore::Face > *	m_pCoreFace

Properties
List< Face^>^	AdjacentFaces `[get]`
	Returns the Faces adjacent to the Face. More...

List< Cell^>^	Cells `[get]`
	Returns the Cells incident to the Face. More...

List< Shell^>^	Shells `[get]`
	Returns the Shells incident to the Face. More...

List< Vertex^>^	Vertices `[get]`
	Returns the Vertices constituent to the Face. More...

List< Edge^>^	Edges `[get]`
	Returns the Edges constituent to the Face. More...

List< Wire^>^	Wires `[get]`
	Returns the Wires constituent to the Face. More...

Wire^	ExternalBoundary `[get]`
	Returns the external boundary (Wire) of the Face. More...

List< Wire^>^	InternalBoundaries `[get]`
	Returns the internal boundaries (Wires) of the Face. More...

Object^	BasicGeometry `[get]`
	Creates a geometry from Face. More...

Properties inherited from Topologic::Topology
int	Dimensionality `[get]`
	Returns the dimensionality of the Topology. More...

Object^	BasicGeometry `[get]`
	Creates a geometry from the Topology. More...

Object^	Geometry `[get]`
	Creates a geometry from Topology. More...

List< Topology^>^	Contents `[get]`
	Returns the contents (non-constituent members) of the input Topology. More...

List< Aperture^>^	Apertures `[get]`
	Returns the Apertures of the input Topology. More...

List< Topology^>^	SubContents `[get]`
	Returns the sub-contents (contents of the constituent members) of a Topology. More...

List< Context^>^	Contexts `[get]`
	Returns the Topologies containing the input Topology as a content. More...

Vertex^	CenterOfMass `[get]`
	Returns the center of mass of any Topology. More...

Vertex^	Centroid `[get]`
	Returns the centroid of any Topology. More...

bool	IsReversed `[get]`

List< Topology^>^	SubTopologies `[get]`
	Returns all sub-topologies (immediate constituent members) of a Topology. More...

List< Shell^>^	Shells `[get]`
	Returns the Shells constituent to the Topology. More...

List< Face^>^	Faces `[get]`
	Returns the Faces constituent to the Topology. More...

List< Wire^>^	Wires `[get]`
	Returns the Wires constituent to the Topology. More...

List< Edge^>^	Edges `[get]`
	Returns the Edges constituent to the Topology. More...

List< Vertex^>^	Vertices `[get]`
	Returns the Vertices constituent to the Topology. More...

List< Cell^>^	Cells `[get]`
	Returns the Cells constituent to the Topology. More...

List< CellComplex^>^	CellComplexes `[get]`
	Returns the CellComplexes constituent to the Topology. More...

String^	TypeAsString `[get]`
	Returns the instance type as a string. More...

int	Type `[get]`
	Returns the type associated to the Topology. More...

System::Collections::Generic::Dictionary< String^, Object^>^	Dictionary `[get]`
	Returns the dictionary of a Topology. More...

Additional Inherited Members
Public Attributes inherited from Topologic::Topology
template<class T >
where	T: Topology T Copy()
	Copies a Topology and its contents. More...

Static Protected Member Functions inherited from Topologic::Topology
static Topology ^	ByCoreTopology (const std::shared_ptr< TopologicCore::Topology > &kpCoreTopology)

Detailed Description

A Face is a two-dimensional region defined by a collection of closed Wires. The geometry of a face can be flat or undulating.

Constructor & Destructor Documentation

◆ Face()

Topologic::Face::Face ( const std::shared_ptr< TopologicCore::Face > & kpCoreFace )

protected

Parameters

kpCoreFace

Member Function Documentation

◆ AddApertureDesign()

Face Topologic::Face::AddApertureDesign	(	Face^	apertureDesign,
		int	numEdgeSamples
	)

Adds an Aperture design to a Face.

Parameters

apertureDesign	The Aperture design (Topologic Face) to be added
numEdgeSamples	The number of sample points along the Aperture Edges

Returns: The new Face

◆ AddInternalBoundaries()

Face Topologic::Face::AddInternalBoundaries ( List< Wire^>^ internalBoundaries )

Adds internal boundaries (Wires) to a Face.

Parameters

internalBoundaries A list of internal Wires

Returns: The new Face

◆ ByEdges()

Face Topologic::Face::ByEdges ( System::Collections::Generic::IEnumerable< Edge^>^ edges )

static

Creates a Face by a list of Edges.

Parameters

edges A list of Edges

Exceptions

ArgumentException Thrown if any of the arguments is not a Topologic Edge

Returns: The created Face

◆ ByExternalInternalBoundaries()

Face Topologic::Face::ByExternalInternalBoundaries	(	Wire^	externalBoundary,
		System::Collections::Generic::IEnumerable< Wire^>^	internalBoundaries
	)

static

Creates a Face by an external boundary (Wire) and internal boundaries (Wires).

Parameters

externalBoundary	An external Wire
internalBoundaries	A set of internal Wires

Returns: The created Face

◆ ByWire()

Face Topologic::Face::ByWire ( Wire^ wire )

static

Creates a Face by a closed planar Wire.

Parameters

wire	A closed planar Wire

Exceptions

ArgumentException Thrown if any of the arguments is neither a Dynamo polygon nor a Topologic Wire

Returns: The created Face

◆ GetCoreTopologicalQuery()

std::shared_ptr< TopologicCore::TopologicalQuery > Topologic::Face::GetCoreTopologicalQuery ( )

overrideprotectedvirtual

Returns

Implements Topologic::TopologicalQuery.

◆ SharedEdges()

List< Edge^> Topologic::Face::SharedEdges ( Face^ face )

Returns the shared Edges between two Faces.

Parameters

face	Another Face

Returns: A list of shared Edges

◆ SharedVertices()

List< Vertex^> Topologic::Face::SharedVertices ( Face^ face )

Returns the shared Vertices between two Faces.

Parameters

face	Another Face

Returns: A list of shared Vertices

◆ Surface() [1/3]

Object Topologic::Face::Surface ( )

protected

Returns

◆ Surface() [2/3]

NurbsSurface Topologic::Face::Surface ( Handle(Geom_BSplineSurface) pOcctBSplineSurface )

protected

Returns

◆ Surface() [3/3]

PlanarSurface Topologic::Face::Surface ( Handle(Geom_Plane) pOcctPlane )

protected

Parameters

pOcctPlane

Returns

◆ Type()

int Topologic::Face::Type ( )

static

Returns the type associated to Face.

Returns: The type associated to Face

Member Data Documentation

◆ m_pCoreFace

std::shared_ptr<TopologicCore::Face>* Topologic::Face::m_pCoreFace

protected

Property Documentation

◆ AdjacentFaces

List< Face^>^ Topologic::Face::AdjacentFaces

get

Returns the Faces adjacent to the Face.

Returns: A list of Faces adjacent to the Face

◆ BasicGeometry

Object^ Topologic::Face::BasicGeometry

get

Creates a geometry from Face.

Returns: The created geometry

◆ Cells

List< Cell^>^ Topologic::Face::Cells

get

Returns the Cells incident to the Face.

Returns: A list of Cells incident to the Face

◆ Edges

List< Edge^>^ Topologic::Face::Edges

get

Returns the Edges constituent to the Face.

Returns: A list of Edges constituent to the Face

◆ ExternalBoundary

Wire^ Topologic::Face::ExternalBoundary

get

Returns the external boundary (Wire) of the Face.

Returns: The external Wire of the Face

◆ InternalBoundaries

List< Wire^>^ Topologic::Face::InternalBoundaries

get

Returns the internal boundaries (Wires) of the Face.

Returns: A list of the internal Wires of the Face

◆ Shells

List< Shell^>^ Topologic::Face::Shells

get

Returns the Shells incident to the Face.

Returns: A list of Shells incident to the Face

◆ Vertices

List< Vertex^>^ Topologic::Face::Vertices

get

Returns the Vertices constituent to the Face.

Returns: A list of Vertices constituent to the Face

◆ Wires

List< Wire^>^ Topologic::Face::Wires

get

Returns the Wires constituent to the Face.

Returns: A list of Wires constituent to the Face

The documentation for this class was generated from the following files:

include/Face.h
src/Face.cpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Face()

Member Function Documentation

◆ AddApertureDesign()

◆ AddInternalBoundaries()

◆ ByEdges()

◆ ByExternalInternalBoundaries()

◆ ByWire()

◆ GetCoreTopologicalQuery()

◆ SharedEdges()

◆ SharedVertices()

◆ Surface() [1/3]

◆ Surface() [2/3]

◆ Surface() [3/3]

◆ Type()

Member Data Documentation

◆ m_pCoreFace

Property Documentation

◆ AdjacentFaces

◆ BasicGeometry

◆ Cells

◆ Edges

◆ ExternalBoundary

◆ InternalBoundaries

◆ Shells

◆ Vertices

◆ Wires