Topologic  0.8.9
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Properties | List of all members
Topologic::Wire Class Reference

A Wire is a contiguous collection of Edges, where adjacent Edges are connected by shared Vertices. It may be open or closed and may be manifold or non-manifold. More...

#include <Wire.h>

Inheritance diagram for Topologic::Wire:
Topologic::Topology Topologic::TopologicalQuery

Public Member Functions

int GetNumberOfBranches ()
 Returns the number of branches of the Wire. More...
 
- Public Member Functions inherited from Topologic::Topology
TopologyAddContents (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...
 
TopologyRemoveContent (Topology^ contentTopology)
 Removes a content (non-constituent member) from a Topology. More...
 
TopologyRemoveContents (List< Topology^>^ contentTopologies)
 Removes contents (non-constituent members) from a Topology. More...
 
TopologyAddApertures (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...
 
TopologyDifference (Topology^ topology)
 Performs the Difference operation between the input Topology and another Topology. More...
 
TopologyImpose (Topologic::Topology^ tool)
 Imposes another Topology on the input Topology. More...
 
TopologyImprint (Topology^ tool)
 Imprints another Topology on the input Topology. More...
 
TopologyIntersect (Topology^ topology)
 Performs the Intersection operation between the input Topology and another Topology. More...
 
TopologyMerge (Topology^ topology)
 Merges the input Topology and another Topology. More...
 
TopologySelfMerge ()
 Merges the sub-topologies of the input Topology. More...
 
TopologySlice (Topology^ tool)
 Slices the input Topology with another Topology. More...
 
TopologyDivide (Topology^ tool)
 Divides the input Topology with another Topology. More...
 
TopologyUnion (Topology^ topology)
 Unions the input Topology and another Topology. More...
 
TopologyXOR (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...
 
TopologyClosestSimplestSubshape (Topology^ selector)
 Returns the sub-topology that is the closest to the selector and the simplest (i.e. has the lowest dimensionality). More...
 
TopologySelectSubtopology (Vertex^ selector, int typeFilter)
 Returns the sub-topology that is the closest to the selector Vertex and of a specific type. More...
 
TopologyShallowCopy ()
 Copies a Topology without its contents. More...
 
TopologySetDictionary (Dictionary< String^, Object^>^ dictionary)
 Sets a dictionary for a Topology. More...
 
TopologySetDictionaries (List< Vertex^>^ selectors, List< Dictionary< String^, Object^>^>^ dictionaries, int typeFilter)
 Sets a list of dictionaries for a Topology. More...
 

Static Public Member Functions

static WireByEdges (System::Collections::Generic::IEnumerable< Edge^>^ edges)
 Creates a Wire by a set of Edges. More...
 
static int Type ()
 Returns the type associated to Wire. 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 TopologyByImportedBRep (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

 Wire (const std::shared_ptr< TopologicCore::Wire > &kpCoreWire)
 
virtual std::shared_ptr< TopologicCore::TopologicalQuery > GetCoreTopologicalQuery () override
 
- Protected Member Functions inherited from Topologic::Topology
Object ^ CleanupGeometryOutput (List< Object^>^ geometry)
 

Protected Attributes

std::shared_ptr< TopologicCore::Wire > * m_pCoreWire
 

Properties

List< Edge^>^ Edges [get]
 Returns the Edges constituent to the Wire. NOTE: This method will automatically identify its loop order property. More...
 
List< Face^>^ Faces [get]
 Returns the Faces containing the Wire. More...
 
List< Vertex^>^ Vertices [get]
 Returns the Vertices constituent to the Wire. NOTE: This method will automatically identify its loop order property. More...
 
bool IsClosed [get]
 Checks if the Wire is closed. More...
 
Object^ BasicGeometry [get]
 Creates a geometry from Wire. 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...
 
VertexCenterOfMass [get]
 Returns the center of mass of any Topology. More...
 
VertexCentroid [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 TopologyByCoreTopology (const std::shared_ptr< TopologicCore::Topology > &kpCoreTopology)
 

Detailed Description

A Wire is a contiguous collection of Edges, where adjacent Edges are connected by shared Vertices. It may be open or closed and may be manifold or non-manifold.

Constructor & Destructor Documentation

◆ Wire()

Topologic::Wire::Wire ( const std::shared_ptr< TopologicCore::Wire > &  kpCoreWire)
protected

Parameters
kpCoreWire

Member Function Documentation

◆ ByEdges()

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

Creates a Wire by a set of Edges.

Parameters
edgesThe set of Edges
Exceptions
ArgumentExceptionThrown if any of the arguments is not a Topologic Edge
Returns
The created Wire

◆ GetCoreTopologicalQuery()

std::shared_ptr< TopologicCore::TopologicalQuery > Topologic::Wire::GetCoreTopologicalQuery ( )
overrideprotectedvirtual

Returns

Implements Topologic::TopologicalQuery.

◆ GetNumberOfBranches()

int Topologic::Wire::GetNumberOfBranches ( )

Returns the number of branches of the Wire.

Returns
The number of branches

◆ Type()

int Topologic::Wire::Type ( )
static

Returns the type associated to Wire.

Returns
The type associated to Wire

Member Data Documentation

◆ m_pCoreWire

std::shared_ptr<TopologicCore::Wire>* Topologic::Wire::m_pCoreWire
protected

Property Documentation

◆ BasicGeometry

Object^ Topologic::Wire::BasicGeometry
get

Creates a geometry from Wire.

Returns
The created geometry

◆ Edges

List< Edge^>^ Topologic::Wire::Edges
get

Returns the Edges constituent to the Wire. NOTE: This method will automatically identify its loop order property.

Returns
A list of Edges constituent to the Wire

◆ Faces

List< Face^>^ Topologic::Wire::Faces
get

Returns the Faces containing the Wire.

Returns
A list of Faces containing the Wire

◆ IsClosed

bool Topologic::Wire::IsClosed
get

Checks if the Wire is closed.

Returns
True if the Wire is closed, otherwise false

◆ Vertices

List< Vertex^>^ Topologic::Wire::Vertices
get

Returns the Vertices constituent to the Wire. NOTE: This method will automatically identify its loop order property.

Returns
A list of Vertices constituent to the Wire

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